feat:添加adguardhome、memcached、qiandao、lsky-pro、bitwarden、rustdesk、synapse (#187)
96
apps/adguardhome/0.107.32/data.yml
Normal file
@ -0,0 +1,96 @@
|
||||
additionalProperties:
|
||||
formFields:
|
||||
- default: 20053
|
||||
edit: true
|
||||
envKey: PLAIN_DNS_PORT
|
||||
labelEn: Plain DNS port
|
||||
labelZh: 普通DNS端口
|
||||
required: true
|
||||
rule: paramPort
|
||||
type: number
|
||||
- default: 20067
|
||||
edit: true
|
||||
envKey: DHCP_PORT1
|
||||
labelEn: DHCP service port 1
|
||||
labelZh: DHCP服务端口1
|
||||
required: true
|
||||
rule: paramPort
|
||||
type: number
|
||||
- default: 20068
|
||||
edit: true
|
||||
envKey: DHCP_PORT2
|
||||
labelEn: DHCP service port 2
|
||||
labelZh: DHCP服务端口2
|
||||
required: true
|
||||
rule: paramPort
|
||||
type: number
|
||||
- default: 23000
|
||||
edit: true
|
||||
envKey: HTTP_PORT
|
||||
labelEn: HTTP web port
|
||||
labelZh: HTTP网页端口
|
||||
required: true
|
||||
rule: paramPort
|
||||
type: number
|
||||
- default: 23001
|
||||
edit: true
|
||||
envKey: PANEL_APP_PORT_HTTP
|
||||
labelEn: Initial setup web page port
|
||||
labelZh: 初始设置网页端口
|
||||
required: true
|
||||
rule: paramPort
|
||||
type: number
|
||||
- default: 20443
|
||||
edit: true
|
||||
envKey: DOH_PORT
|
||||
labelEn: DOH service port
|
||||
labelZh: DOH服务端口
|
||||
required: true
|
||||
rule: paramPort
|
||||
type: number
|
||||
- default: 853
|
||||
edit: true
|
||||
envKey: DOT_PORT
|
||||
labelEn: DOT service port
|
||||
labelZh: DOT服务端口
|
||||
required: true
|
||||
rule: paramPort
|
||||
type: number
|
||||
- default: 20784
|
||||
edit: true
|
||||
envKey: QUIC_PORT1
|
||||
labelEn: QUIC service port 1
|
||||
labelZh: QUIC服务端口1
|
||||
required: true
|
||||
rule: paramPort
|
||||
type: number
|
||||
- default: 8853
|
||||
edit: true
|
||||
envKey: QUIC_PORT2
|
||||
labelEn: QUIC service port 2
|
||||
labelZh: QUIC服务端口2
|
||||
required: true
|
||||
rule: paramPort
|
||||
type: number
|
||||
- default: 5443
|
||||
edit: true
|
||||
envKey: DNS_CRYPT_PORT
|
||||
labelEn: DNS Crypt service port
|
||||
labelZh: DNS Crypt服务端口
|
||||
required: true
|
||||
rule: paramPort
|
||||
type: number
|
||||
- default: ./data/work
|
||||
edit: true
|
||||
envKey: WORK_PATH
|
||||
labelEn: Work data folder path
|
||||
labelZh: 工作数据文件夹路径
|
||||
required: true
|
||||
type: text
|
||||
- default: ./data/conf
|
||||
edit: true
|
||||
envKey: CONFIG_PATH
|
||||
labelEn: Configuration folder path
|
||||
labelZh: 配置文件夹路径
|
||||
required: true
|
||||
type: text
|
32
apps/adguardhome/0.107.32/docker-compose.yml
Normal file
@ -0,0 +1,32 @@
|
||||
version: '3'
|
||||
services:
|
||||
adguardhome:
|
||||
container_name: ${CONTAINER_NAME}
|
||||
restart: always
|
||||
networks:
|
||||
- 1panel-network
|
||||
ports:
|
||||
- ${PLAIN_DNS_PORT}:53/tcp
|
||||
- ${PLAIN_DNS_PORT}:53/udp
|
||||
- ${DHCP_PORT1}:67/udp
|
||||
- ${DHCP_PORT2}:68/udp
|
||||
- ${HTTP_PORT}:80/tcp
|
||||
- ${DOH_PORT}:443/tcp
|
||||
- ${DOH_PORT}:443/udp
|
||||
- ${PANEL_APP_PORT_HTTP}:3000/tcp
|
||||
- ${DOT_PORT}:853/tcp
|
||||
- ${QUIC_PORT1}:784/udp
|
||||
- ${DOT_PORT}:853/udp
|
||||
- ${QUIC_PORT2}:8853/udp
|
||||
- ${DNS_CRYPT_PORT}:5443/tcp
|
||||
- ${DNS_CRYPT_PORT}:5443/udp
|
||||
volumes:
|
||||
- ${WORK_PATH}:/opt/adguardhome/work
|
||||
- ${CONFIG_PATH}:/opt/adguardhome/conf
|
||||
image: adguard/adguardhome:v0.107.32
|
||||
labels:
|
||||
createdBy: "Apps"
|
||||
|
||||
networks:
|
||||
1panel-network:
|
||||
external: true
|
529
apps/adguardhome/README.md
Normal file
@ -0,0 +1,529 @@
|
||||
|
||||
<p align="center">
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="doc/adguard_home_darkmode.svg">
|
||||
<img alt="AdGuard Home" src="https://raw.githubusercontent.com/AdguardTeam/AdGuardHome/master/doc/adguard_home_lightmode.svg" width="300px">
|
||||
</picture>
|
||||
</p>
|
||||
<h3 align="center">Privacy protection center for you and your devices</h3>
|
||||
<p align="center">
|
||||
Free and open source, powerful network-wide ads & trackers blocking DNS
|
||||
server.
|
||||
</p>
|
||||
<p align="center">
|
||||
<a href="https://adguard.com/">AdGuard.com</a> |
|
||||
<a href="https://github.com/AdguardTeam/AdGuardHome/wiki">Wiki</a> |
|
||||
<a href="https://reddit.com/r/Adguard">Reddit</a> |
|
||||
<a href="https://twitter.com/AdGuard">Twitter</a> |
|
||||
<a href="https://t.me/adguard_en">Telegram</a>
|
||||
<br/><br/>
|
||||
<a href="https://codecov.io/github/AdguardTeam/AdGuardHome?branch=master">
|
||||
<img src="https://img.shields.io/codecov/c/github/AdguardTeam/AdGuardHome/master.svg" alt="Code Coverage"/>
|
||||
</a>
|
||||
<a href="https://goreportcard.com/report/AdguardTeam/AdGuardHome">
|
||||
<img src="https://goreportcard.com/badge/github.com/AdguardTeam/AdGuardHome" alt="Go Report Card"/>
|
||||
</a>
|
||||
<a href="https://hub.docker.com/r/adguard/adguardhome">
|
||||
<img alt="Docker Pulls" src="https://img.shields.io/docker/pulls/adguard/adguardhome.svg?maxAge=604800"/>
|
||||
</a>
|
||||
<br/>
|
||||
<a href="https://github.com/AdguardTeam/AdGuardHome/releases">
|
||||
<img src="https://img.shields.io/github/release/AdguardTeam/AdGuardHome/all.svg" alt="Latest release"/>
|
||||
</a>
|
||||
<a href="https://snapcraft.io/adguard-home">
|
||||
<img alt="adguard-home" src="https://snapcraft.io/adguard-home/badge.svg"/>
|
||||
</a>
|
||||
</p>
|
||||
<br/>
|
||||
<p align="center">
|
||||
<img src="https://cdn.adtidy.org/public/Adguard/Common/adguard_home.gif" width="800"/>
|
||||
</p>
|
||||
<hr/>
|
||||
|
||||
AdGuard Home is a network-wide software for blocking ads and tracking. After you
|
||||
set it up, it'll cover ALL your home devices, and you don't need any client-side
|
||||
software for that.
|
||||
|
||||
It operates as a DNS server that re-routes tracking domains to a “black hole”,
|
||||
thus preventing your devices from connecting to those servers. It's based on
|
||||
software we use for our public [AdGuard DNS] servers, and both share a lot of
|
||||
code.
|
||||
|
||||
[AdGuard DNS]: https://adguard-dns.io/
|
||||
|
||||
|
||||
|
||||
* [Getting Started](#getting-started)
|
||||
* [Automated install (Unix)](#automated-install-linux-and-mac)
|
||||
* [Alternative methods](#alternative-methods)
|
||||
* [Guides](#guides)
|
||||
* [API](#api)
|
||||
* [Comparing AdGuard Home to other solutions](#comparison)
|
||||
* [How is this different from public AdGuard DNS servers?](#comparison-adguard-dns)
|
||||
* [How does AdGuard Home compare to Pi-Hole](#comparison-pi-hole)
|
||||
* [How does AdGuard Home compare to traditional ad blockers](#comparison-adblock)
|
||||
* [Known limitations](#comparison-limitations)
|
||||
* [How to build from source](#how-to-build)
|
||||
* [Prerequisites](#prerequisites)
|
||||
* [Building](#building)
|
||||
* [Contributing](#contributing)
|
||||
* [Test unstable versions](#test-unstable-versions)
|
||||
* [Reporting issues](#reporting-issues)
|
||||
* [Help with translations](#translate)
|
||||
* [Other](#help-other)
|
||||
* [Projects that use AdGuard Home](#uses)
|
||||
* [Acknowledgments](#acknowledgments)
|
||||
* [Privacy](#privacy)
|
||||
|
||||
|
||||
|
||||
## <a href="#getting-started" id="getting-started" name="getting-started">Getting Started</a>
|
||||
|
||||
### <a href="#automated-install-linux-and-mac" id="automated-install-linux-and-mac" name="automated-install-linux-and-mac">Automated install (Unix)</a>
|
||||
|
||||
To install with `curl` run the following command:
|
||||
|
||||
```sh
|
||||
curl -s -S -L https://raw.githubusercontent.com/AdguardTeam/AdGuardHome/master/scripts/install.sh | sh -s -- -v
|
||||
```
|
||||
|
||||
To install with `wget` run the following command:
|
||||
|
||||
```sh
|
||||
wget --no-verbose -O - https://raw.githubusercontent.com/AdguardTeam/AdGuardHome/master/scripts/install.sh | sh -s -- -v
|
||||
```
|
||||
|
||||
To install with `fetch` run the following command:
|
||||
|
||||
```sh
|
||||
fetch -o - https://raw.githubusercontent.com/AdguardTeam/AdGuardHome/master/scripts/install.sh | sh -s -- -v
|
||||
```
|
||||
|
||||
The script also accepts some options:
|
||||
|
||||
* `-c <channel>` to use specified channel;
|
||||
* `-r` to reinstall AdGuard Home;
|
||||
* `-u` to uninstall AdGuard Home;
|
||||
* `-v` for verbose output.
|
||||
|
||||
Note that options `-r` and `-u` are mutually exclusive.
|
||||
|
||||
|
||||
|
||||
### <a href="#alternative-methods" id="alternative-methods" name="alternative-methods">Alternative methods</a>
|
||||
|
||||
#### <a href="#manual-installation" id="manual-installation" name="manual-installation">Manual installation</a>
|
||||
|
||||
Please read the **[Getting Started][wiki-start]** article on our Wiki to learn
|
||||
how to install AdGuard Home manually, and how to configure your devices to use
|
||||
it.
|
||||
|
||||
#### <a href="#docker" id="docker" name="docker">Docker</a>
|
||||
|
||||
You can use our official Docker image on [Docker Hub].
|
||||
|
||||
#### <a href="#snap-store" id="snap-store" name="snap-store">Snap Store</a>
|
||||
|
||||
If you're running **Linux,** there's a secure and easy way to install AdGuard
|
||||
Home: get it from the [Snap Store].
|
||||
|
||||
[Docker Hub]: https://hub.docker.com/r/adguard/adguardhome
|
||||
[Snap Store]: https://snapcraft.io/adguard-home
|
||||
[wiki-start]: https://github.com/AdguardTeam/AdGuardHome/wiki/Getting-Started
|
||||
|
||||
|
||||
|
||||
### <a href="#guides" id="guides" name="guides">Guides</a>
|
||||
|
||||
See our [Wiki][wiki].
|
||||
|
||||
[wiki]: https://github.com/AdguardTeam/AdGuardHome/wiki
|
||||
|
||||
|
||||
|
||||
### <a href="#api" id="api" name="api">API</a>
|
||||
|
||||
If you want to integrate with AdGuard Home, you can use our [REST API][openapi].
|
||||
Alternatively, you can use this [python client][pyclient], which is used to
|
||||
build the [AdGuard Home Hass.io Add-on][hassio].
|
||||
|
||||
[hassio]: https://www.home-assistant.io/integrations/adguard/
|
||||
[openapi]: https://github.com/AdguardTeam/AdGuardHome/tree/master/openapi
|
||||
[pyclient]: https://pypi.org/project/adguardhome/
|
||||
|
||||
|
||||
|
||||
## <a href="#comparison" id="comparison" name="comparison">Comparing AdGuard Home to other solutions</a>
|
||||
|
||||
### <a href="#comparison-adguard-dns" id="comparison-adguard-dns" name="comparison-adguard-dns">How is this different from public AdGuard DNS servers?</a>
|
||||
|
||||
Running your own AdGuard Home server allows you to do much more than using a
|
||||
public DNS server. It's a completely different level. See for yourself:
|
||||
|
||||
* Choose what exactly the server blocks and permits.
|
||||
|
||||
* Monitor your network activity.
|
||||
|
||||
* Add your own custom filtering rules.
|
||||
|
||||
* **Most importantly, it's your own server, and you are the only one who's in
|
||||
control.**
|
||||
|
||||
|
||||
|
||||
### <a href="#comparison-pi-hole" id="comparison-pi-hole" name="comparison-pi-hole">How does AdGuard Home compare to Pi-Hole</a>
|
||||
|
||||
At this point, AdGuard Home has a lot in common with Pi-Hole. Both block ads
|
||||
and trackers using the so-called “DNS sinkholing” method and both allow
|
||||
customizing what's blocked.
|
||||
|
||||
<aside>
|
||||
We're not going to stop here. DNS sinkholing is not a bad starting point, but
|
||||
this is just the beginning.
|
||||
</aside>
|
||||
|
||||
AdGuard Home provides a lot of features out-of-the-box with no need to install
|
||||
and configure additional software. We want it to be simple to the point when
|
||||
even casual users can set it up with minimal effort.
|
||||
|
||||
**Disclaimer:** some of the listed features can be added to Pi-Hole by
|
||||
installing additional software or by manually using SSH terminal and
|
||||
reconfiguring one of the utilities Pi-Hole consists of. However, in our
|
||||
opinion, this cannot be legitimately counted as a Pi-Hole's feature.
|
||||
|
||||
| Feature | AdGuard Home | Pi-Hole |
|
||||
|-------------------------------------------------------------------------|-------------------|-----------------------------------------------------------|
|
||||
| Blocking ads and trackers | ✅ | ✅ |
|
||||
| Customizing blocklists | ✅ | ✅ |
|
||||
| Built-in DHCP server | ✅ | ✅ |
|
||||
| HTTPS for the Admin interface | ✅ | Kind of, but you'll need to manually configure lighttpd |
|
||||
| Encrypted DNS upstream servers (DNS-over-HTTPS, DNS-over-TLS, DNSCrypt) | ✅ | ❌ (requires additional software) |
|
||||
| Cross-platform | ✅ | ❌ (not natively, only via Docker) |
|
||||
| Running as a DNS-over-HTTPS or DNS-over-TLS server | ✅ | ❌ (requires additional software) |
|
||||
| Blocking phishing and malware domains | ✅ | ❌ (requires non-default blocklists) |
|
||||
| Parental control (blocking adult domains) | ✅ | ❌ |
|
||||
| Force Safe search on search engines | ✅ | ❌ |
|
||||
| Per-client (device) configuration | ✅ | ✅ |
|
||||
| Access settings (choose who can use AGH DNS) | ✅ | ❌ |
|
||||
| Running [without root privileges][wiki-noroot] | ✅ | ❌ |
|
||||
|
||||
[wiki-noroot]: https://github.com/AdguardTeam/AdGuardHome/wiki/Getting-Started#running-without-superuser
|
||||
|
||||
|
||||
|
||||
### <a href="#comparison-adblock" id="comparison-adblock" name="comparison-adblock">How does AdGuard Home compare to traditional ad blockers</a>
|
||||
|
||||
It depends.
|
||||
|
||||
DNS sinkholing is capable of blocking a big percentage of ads, but it lacks
|
||||
the flexibility and the power of traditional ad blockers. You can get a good
|
||||
impression about the difference between these methods by reading [this
|
||||
article][blog-adaway], which compares AdGuard for Android (a traditional ad
|
||||
blocker) to hosts-level ad blockers (which are almost identical to DNS-based
|
||||
blockers in their capabilities). This level of protection is enough for some
|
||||
users.
|
||||
|
||||
Additionally, using a DNS-based blocker can help to block ads, tracking and
|
||||
analytics requests on other types of devices, such as SmartTVs, smart speakers
|
||||
or other kinds of IoT devices (on which you can't install traditional ad
|
||||
blockers).
|
||||
|
||||
|
||||
|
||||
### <a href="#comparison-limitations" id="comparison-limitations" name="comparison-limitations">Known limitations</a>
|
||||
|
||||
Here are some examples of what cannot be blocked by a DNS-level blocker:
|
||||
|
||||
* YouTube, Twitch ads;
|
||||
|
||||
* Facebook, Twitter, Instagram sponsored posts.
|
||||
|
||||
Essentially, any advertising that shares a domain with content cannot be blocked
|
||||
by a DNS-level blocker.
|
||||
|
||||
Is there a chance to handle this in the future? DNS will never be enough to do
|
||||
this. Our only option is to use a content blocking proxy like what we do in the
|
||||
standalone AdGuard applications. We're [going to bring][issue-1228] this
|
||||
feature support to AdGuard Home in the future. Unfortunately, even in this
|
||||
case, there still will be cases when this won't be enough or would require quite
|
||||
a complicated configuration.
|
||||
|
||||
[blog-adaway]: https://adguard.com/blog/adguard-vs-adaway-dns66.html
|
||||
[issue-1228]: https://github.com/AdguardTeam/AdGuardHome/issues/1228
|
||||
|
||||
|
||||
|
||||
## <a href="#how-to-build" id="how-to-build" name="how-to-build">How to build from source</a>
|
||||
|
||||
### <a href="#prerequisites" id="prerequisites" name="prerequisites">Prerequisites</a>
|
||||
|
||||
Run `make init` to prepare the development environment.
|
||||
|
||||
You will need this to build AdGuard Home:
|
||||
|
||||
* [Go](https://golang.org/dl/) v1.19 or later;
|
||||
* [Node.js](https://nodejs.org/en/download/) v10.16.2 or later;
|
||||
* [npm](https://www.npmjs.com/) v6.14 or later;
|
||||
* [yarn](https://yarnpkg.com/) v1.22.5 or later.
|
||||
|
||||
|
||||
|
||||
### <a href="#building" id="building" name="building">Building</a>
|
||||
|
||||
Open your terminal and execute these commands:
|
||||
|
||||
```sh
|
||||
git clone https://github.com/AdguardTeam/AdGuardHome
|
||||
cd AdGuardHome
|
||||
make
|
||||
```
|
||||
|
||||
**NOTE:** The non-standard `-j` flag is currently not supported, so building
|
||||
with `make -j 4` or setting your `MAKEFLAGS` to include, for example, `-j 4` is
|
||||
likely to break the build. If you do have your `MAKEFLAGS` set to that, and you
|
||||
don't want to change it, you can override it by running `make -j 1`.
|
||||
|
||||
Check the [`Makefile`][src-makefile] to learn about other commands.
|
||||
|
||||
#### <a href="#building-cross" id="building-cross" name="building-cross">Building for a different platform</a>
|
||||
|
||||
You can build AdGuard Home for any OS/ARCH that Go supports. In order to do
|
||||
this, specify `GOOS` and `GOARCH` environment variables as macros when running
|
||||
`make`.
|
||||
|
||||
For example:
|
||||
|
||||
```sh
|
||||
env GOOS='linux' GOARCH='arm64' make
|
||||
```
|
||||
|
||||
or:
|
||||
|
||||
```sh
|
||||
make GOOS='linux' GOARCH='arm64'
|
||||
```
|
||||
|
||||
#### <a href="#preparing-releases" id="preparing-releases" name="preparing-releases">Preparing releases</a>
|
||||
|
||||
You'll need [`snapcraft`] to prepare a release build. Once installed, run the
|
||||
following command:
|
||||
|
||||
```sh
|
||||
make build-release CHANNEL='...' VERSION='...'
|
||||
```
|
||||
|
||||
See the [`build-release` target documentation][targ-release].
|
||||
|
||||
#### <a href="#docker-image" id="docker-image" name="docker-image">Docker image</a>
|
||||
|
||||
Run `make build-docker` to build the Docker image locally (the one that we
|
||||
publish to DockerHub). Please note, that we're using [Docker Buildx][buildx] to
|
||||
build our official image.
|
||||
|
||||
You may need to prepare before using these builds:
|
||||
|
||||
* (Linux-only) Install Qemu:
|
||||
|
||||
```sh
|
||||
docker run --rm --privileged multiarch/qemu-user-static --reset -p yes --credential yes
|
||||
```
|
||||
|
||||
* Prepare the builder:
|
||||
|
||||
```sh
|
||||
docker buildx create --name buildx-builder --driver docker-container --use
|
||||
```
|
||||
|
||||
See the [`build-docker` target documentation][targ-docker].
|
||||
|
||||
#### <a href="#debugging-the-frontend" id="debugging-the-frontend" name="debugging-the-frontend">Debugging the frontend</a>
|
||||
|
||||
When you need to debug the frontend without recompiling the production version
|
||||
every time, for example to check how your labels would look on a form, you can
|
||||
run the frontend build a development environment.
|
||||
|
||||
1. In a separate terminal, run:
|
||||
|
||||
```sh
|
||||
( cd ./client/ && env NODE_ENV='development' npm run watch )
|
||||
```
|
||||
|
||||
2. Run your `AdGuardHome` binary with the `--local-frontend` flag, which
|
||||
instructs AdGuard Home to ignore the built-in frontend files and use those
|
||||
from the `./build/` directory.
|
||||
|
||||
3. Now any changes you make in the `./client/` directory should be recompiled
|
||||
and become available on the web UI. Make sure that you disable the browser
|
||||
cache to make sure that you actually get the recompiled version.
|
||||
|
||||
[`snapcraft`]: https://snapcraft.io/
|
||||
[buildx]: https://docs.docker.com/buildx/working-with-buildx/
|
||||
[src-makefile]: https://github.com/AdguardTeam/AdGuardHome/blob/master/Makefile
|
||||
[targ-docker]: https://github.com/AdguardTeam/AdGuardHome/tree/master/scripts#build-dockersh-build-a-multi-architecture-docker-image
|
||||
[targ-release]: https://github.com/AdguardTeam/AdGuardHome/tree/master/scripts#build-releasesh-build-a-release-for-all-platforms
|
||||
|
||||
|
||||
|
||||
## <a href="#contributing" id="contributing" name="contributing">Contributing</a>
|
||||
|
||||
You are welcome to fork this repository, make your changes and [submit a pull
|
||||
request][pr]. Please make sure you follow our [code guidelines][guide] though.
|
||||
|
||||
Please note that we don't expect people to contribute to both UI and backend
|
||||
parts of the program simultaneously. Ideally, the backend part is implemented
|
||||
first, i.e. configuration, API, and the functionality itself. The UI part can
|
||||
be implemented later in a different pull request by a different person.
|
||||
|
||||
[guide]: https://github.com/AdguardTeam/CodeGuidelines/
|
||||
[pr]: https://github.com/AdguardTeam/AdGuardHome/pulls
|
||||
|
||||
|
||||
|
||||
### <a href="#test-unstable-versions" id="test-unstable-versions" name="test-unstable-versions">Test unstable versions</a>
|
||||
|
||||
There are two update channels that you can use:
|
||||
|
||||
* `beta`: beta versions of AdGuard Home. More or less stable versions,
|
||||
usually released every two weeks or more often.
|
||||
|
||||
* `edge`: the newest version of AdGuard Home from the development branch. New
|
||||
updates are pushed to this channel daily.
|
||||
|
||||
There are three options how you can install an unstable version:
|
||||
|
||||
1. [Snap Store]: look for the `beta` and `edge` channels.
|
||||
|
||||
2. [Docker Hub]: look for the `beta` and `edge` tags.
|
||||
|
||||
3. Standalone builds. Use the automated installation script or look for the
|
||||
available builds [on the Wiki][wiki-platf].
|
||||
|
||||
Script to install a beta version:
|
||||
|
||||
```sh
|
||||
curl -s -S -L https://raw.githubusercontent.com/AdguardTeam/AdGuardHome/master/scripts/install.sh | sh -s -- -c beta
|
||||
```
|
||||
|
||||
Script to install an edge version:
|
||||
|
||||
```sh
|
||||
curl -s -S -L https://raw.githubusercontent.com/AdguardTeam/AdGuardHome/master/scripts/install.sh | sh -s -- -c edge
|
||||
```
|
||||
[wiki-platf]: https://github.com/AdguardTeam/AdGuardHome/wiki/Platforms
|
||||
|
||||
|
||||
|
||||
### <a href="#reporting-issues" id="reporting-issues" name="reporting-issues">Report issues</a>
|
||||
|
||||
If you run into any problem or have a suggestion, head to [this page][iss] and
|
||||
click on the “New issue” button.
|
||||
|
||||
[iss]: https://github.com/AdguardTeam/AdGuardHome/issues
|
||||
|
||||
|
||||
|
||||
### <a href="#translate" id="translate" name="translate">Help with translations</a>
|
||||
|
||||
If you want to help with AdGuard Home translations, please learn more about
|
||||
translating AdGuard products [in our Knowledge Base][kb-trans]. You can
|
||||
contribute to the [AdGuardHome project on CrowdIn][crowdin].
|
||||
|
||||
[crowdin]: https://crowdin.com/project/adguard-applications/en#/adguard-home
|
||||
[kb-trans]: https://kb.adguard.com/en/general/adguard-translations
|
||||
|
||||
|
||||
|
||||
### <a href="#help-other" id="help-other" name="help-other">Other</a>
|
||||
|
||||
Another way you can contribute is by [looking for issues][iss-help] marked as
|
||||
`help wanted`, asking if the issue is up for grabs, and sending a PR fixing the
|
||||
bug or implementing the feature.
|
||||
|
||||
[iss-help]: https://github.com/AdguardTeam/AdGuardHome/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22
|
||||
|
||||
|
||||
|
||||
## <a href="#uses" id="uses" name="uses">Projects that use AdGuard Home</a>
|
||||
|
||||
<!--
|
||||
TODO(a.garipov): Use reference links.
|
||||
-->
|
||||
|
||||
* [AdGuard Home Remote](https://apps.apple.com/app/apple-store/id1543143740):
|
||||
iOS app by [Joost](https://rocketscience-it.nl/).
|
||||
|
||||
* [Python library](https://github.com/frenck/python-adguardhome) by
|
||||
[@frenck](https://github.com/frenck).
|
||||
|
||||
* [Home Assistant add-on](https://github.com/hassio-addons/addon-adguard-home)
|
||||
by [@frenck](https://github.com/frenck).
|
||||
|
||||
* [OpenWrt LUCI app](https://github.com/kongfl888/luci-app-adguardhome) by
|
||||
[@kongfl888](https://github.com/kongfl888) (originally by
|
||||
[@rufengsuixing](https://github.com/rufengsuixing)).
|
||||
|
||||
* [Prometheus exporter for AdGuard
|
||||
Home](https://github.com/ebrianne/adguard-exporter) by
|
||||
[@ebrianne](https://github.com/ebrianne).
|
||||
|
||||
* [Terminal-based, real-time traffic monitoring and statistics for your AdGuard Home
|
||||
instance](https://github.com/Lissy93/AdGuardian-Term) by
|
||||
[@Lissy93](https://github.com/Lissy93)
|
||||
|
||||
* [AdGuard Home on GLInet
|
||||
routers](https://forum.gl-inet.com/t/adguardhome-on-gl-routers/10664) by
|
||||
[Gl-Inet](https://gl-inet.com/).
|
||||
|
||||
* [Cloudron app](https://git.cloudron.io/cloudron/adguard-home-app) by
|
||||
[@gramakri](https://github.com/gramakri).
|
||||
|
||||
* [Asuswrt-Merlin-AdGuardHome-Installer](https://github.com/jumpsmm7/Asuswrt-Merlin-AdGuardHome-Installer)
|
||||
by [@jumpsmm7](https://github.com/jumpsmm7) aka
|
||||
[@SomeWhereOverTheRainBow](https://www.snbforums.com/members/somewhereovertherainbow.64179/).
|
||||
|
||||
* [Node.js library](https://github.com/Andrea055/AdguardHomeAPI) by
|
||||
[@Andrea055](https://github.com/Andrea055/).
|
||||
|
||||
|
||||
|
||||
## <a href="#acknowledgments" id="acknowledgments" name="acknowledgments">Acknowledgments</a>
|
||||
|
||||
<!--
|
||||
TODO(a.garipov): Use reference links.
|
||||
-->
|
||||
|
||||
This software wouldn't have been possible without:
|
||||
|
||||
* [Go](https://golang.org/dl/) and its libraries:
|
||||
* [gcache](https://github.com/bluele/gcache)
|
||||
* [miekg's dns](https://github.com/miekg/dns)
|
||||
* [go-yaml](https://github.com/go-yaml/yaml)
|
||||
* [service](https://godoc.org/github.com/kardianos/service)
|
||||
* [dnsproxy](https://github.com/AdguardTeam/dnsproxy)
|
||||
* [urlfilter](https://github.com/AdguardTeam/urlfilter)
|
||||
* [Node.js](https://nodejs.org/) and its libraries:
|
||||
* And many more Node.js packages.
|
||||
* [React.js](https://reactjs.org)
|
||||
* [Tabler](https://github.com/tabler/tabler)
|
||||
* [whotracks.me data](https://github.com/cliqz-oss/whotracks.me)
|
||||
|
||||
You might have seen that [CoreDNS] was mentioned here before, but we've stopped
|
||||
using it in AdGuard Home.
|
||||
|
||||
For the full list of all Node.js packages in use, please take a look at
|
||||
[`client/package.json`][src-packagejson] file.
|
||||
|
||||
[CoreDNS]: https://coredns.io
|
||||
[src-packagejson]: https://github.com/AdguardTeam/AdGuardHome/blob/master/client/package.json
|
||||
|
||||
|
||||
|
||||
## <a href="#privacy" id="privacy" name="privacy">Privacy</a>
|
||||
|
||||
Our main idea is that you are the one, who should be in control of your data.
|
||||
So it is only natural, that AdGuard Home does not collect any usage statistics,
|
||||
and does not use any web services unless you configure it to do so. See also
|
||||
the [full privacy policy][privacy] with every bit that *could in theory be sent*
|
||||
by AdGuard Home is available.
|
||||
|
||||
[privacy]: https://adguard.com/en/privacy/home.html
|
20
apps/adguardhome/data.yml
Normal file
@ -0,0 +1,20 @@
|
||||
name: AdGuardHome
|
||||
tags:
|
||||
- 工具
|
||||
title: 自由且开源的,功能强大的网络广告和跟踪器屏蔽DNS服务器
|
||||
type: 工具
|
||||
description: 自由且开源的,功能强大的网络广告和跟踪器屏蔽DNS服务器
|
||||
additionalProperties:
|
||||
key: adguardhome
|
||||
name: AdGuardHome
|
||||
tags:
|
||||
- Tool
|
||||
shortDescZh: 自由且开源的,功能强大的网络广告和跟踪器屏蔽DNS服务器
|
||||
shortDescEn: Free and open source, powerful network-wide ads & trackers blocking DNS server
|
||||
type: tool
|
||||
crossVersionUpdate: true
|
||||
limit: 0
|
||||
recommend: 0
|
||||
website: https://hub.docker.com/r/adguard/adguardhome
|
||||
github: https://github.com/AdguardTeam/AdGuardHome
|
||||
document: https://github.com/AdguardTeam/AdGuardHome/wiki
|
BIN
apps/adguardhome/logo.png
Normal file
After Width: | Height: | Size: 6.2 KiB |
17
apps/bitwarden/1.28.1/data.yml
Normal file
@ -0,0 +1,17 @@
|
||||
additionalProperties:
|
||||
formFields:
|
||||
- default: 40031
|
||||
edit: true
|
||||
envKey: PANEL_APP_PORT_HTTP
|
||||
labelEn: Port
|
||||
labelZh: 端口
|
||||
required: true
|
||||
rule: paramPort
|
||||
type: number
|
||||
- default: ./data
|
||||
edit: true
|
||||
envKey: DATA_PATH
|
||||
labelEn: Data folder path
|
||||
labelZh: 数据文件夹路径
|
||||
required: true
|
||||
type: text
|
18
apps/bitwarden/1.28.1/docker-compose.yml
Normal file
@ -0,0 +1,18 @@
|
||||
version: '3'
|
||||
services:
|
||||
bitwarden:
|
||||
container_name: ${CONTAINER_NAME}
|
||||
restart: always
|
||||
networks:
|
||||
- 1panel-network
|
||||
ports:
|
||||
- "${PANEL_APP_PORT_HTTP}:80"
|
||||
volumes:
|
||||
- "${DATA_PATH}:/data"
|
||||
image: vaultwarden/server:1.28.1-alpine
|
||||
labels:
|
||||
createdBy: "Apps"
|
||||
|
||||
networks:
|
||||
1panel-network:
|
||||
external: true
|
95
apps/bitwarden/README.md
Normal file
@ -0,0 +1,95 @@
|
||||
### Alternative implementation of the Bitwarden server API written in Rust and compatible with [upstream Bitwarden clients](https://bitwarden.com/download/)*, perfect for self-hosted deployment where running the official resource-heavy service might not be ideal.
|
||||
|
||||
📢 Note: This project was known as Bitwarden_RS and has been renamed to separate itself from the official Bitwarden server in the hopes of avoiding confusion and trademark/branding issues. Please see [#1642](https://github.com/dani-garcia/vaultwarden/discussions/1642) for more explanation.
|
||||
|
||||
---
|
||||
[![Build](https://github.com/dani-garcia/vaultwarden/actions/workflows/build.yml/badge.svg)](https://github.com/dani-garcia/vaultwarden/actions/workflows/build.yml)
|
||||
[![ghcr.io](https://img.shields.io/badge/ghcr.io-download-blue)](https://github.com/dani-garcia/vaultwarden/pkgs/container/vaultwarden)
|
||||
[![Docker Pulls](https://img.shields.io/docker/pulls/vaultwarden/server.svg)](https://hub.docker.com/r/vaultwarden/server)
|
||||
[![Quay.io](https://img.shields.io/badge/Quay.io-download-blue)](https://quay.io/repository/vaultwarden/server)
|
||||
[![Dependency Status](https://deps.rs/repo/github/dani-garcia/vaultwarden/status.svg)](https://deps.rs/repo/github/dani-garcia/vaultwarden)
|
||||
[![GitHub Release](https://img.shields.io/github/release/dani-garcia/vaultwarden.svg)](https://github.com/dani-garcia/vaultwarden/releases/latest)
|
||||
[![AGPL-3.0 Licensed](https://img.shields.io/github/license/dani-garcia/vaultwarden.svg)](https://github.com/dani-garcia/vaultwarden/blob/main/LICENSE.txt)
|
||||
[![Matrix Chat](https://img.shields.io/matrix/vaultwarden:matrix.org.svg?logo=matrix)](https://matrix.to/#/#vaultwarden:matrix.org)
|
||||
|
||||
Image is based on [Rust implementation of Bitwarden API](https://github.com/dani-garcia/vaultwarden).
|
||||
|
||||
**This project is not associated with the [Bitwarden](https://bitwarden.com/) project nor Bitwarden, Inc.**
|
||||
|
||||
#### ⚠️**IMPORTANT**⚠️: When using this server, please report any bugs or suggestions to us directly (look at the bottom of this page for ways to get in touch), regardless of whatever clients you are using (mobile, desktop, browser...). DO NOT use the official support channels.
|
||||
|
||||
---
|
||||
|
||||
## Features
|
||||
|
||||
Basically full implementation of Bitwarden API is provided including:
|
||||
|
||||
* Organizations support
|
||||
* Attachments and Send
|
||||
* Vault API support
|
||||
* Serving the static files for Vault interface
|
||||
* Website icons API
|
||||
* Authenticator and U2F support
|
||||
* YubiKey and Duo support
|
||||
* Emergency Access
|
||||
|
||||
## Installation
|
||||
Pull the docker image and mount a volume from the host for persistent storage:
|
||||
|
||||
```sh
|
||||
docker pull vaultwarden/server:latest
|
||||
docker run -d --name vaultwarden -v /vw-data/:/data/ -p 80:80 vaultwarden/server:latest
|
||||
```
|
||||
This will preserve any persistent data under /vw-data/, you can adapt the path to whatever suits you.
|
||||
|
||||
**IMPORTANT**: Most modern web browsers, disallow the use of Web Crypto APIs in insecure contexts. In this case, you might get an error like `Cannot read property 'importKey'`. To solve this problem, you need to access the web vault via HTTPS or localhost.
|
||||
|
||||
This can be configured in [vaultwarden directly](https://github.com/dani-garcia/vaultwarden/wiki/Enabling-HTTPS) or using a third-party reverse proxy ([some examples](https://github.com/dani-garcia/vaultwarden/wiki/Proxy-examples)).
|
||||
|
||||
If you have an available domain name, you can get HTTPS certificates with [Let's Encrypt](https://letsencrypt.org/), or you can generate self-signed certificates with utilities like [mkcert](https://github.com/FiloSottile/mkcert). Some proxies automatically do this step, like Caddy (see examples linked above).
|
||||
|
||||
## Usage
|
||||
See the [vaultwarden wiki](https://github.com/dani-garcia/vaultwarden/wiki) for more information on how to configure and run the vaultwarden server.
|
||||
|
||||
## Get in touch
|
||||
To ask a question, offer suggestions or new features or to get help configuring or installing the software, please use [GitHub Discussions](https://github.com/dani-garcia/vaultwarden/discussions) or [the forum](https://vaultwarden.discourse.group/).
|
||||
|
||||
If you spot any bugs or crashes with vaultwarden itself, please [create an issue](https://github.com/dani-garcia/vaultwarden/issues/). Make sure you are on the latest version and there aren't any similar issues open, though!
|
||||
|
||||
If you prefer to chat, we're usually hanging around at [#vaultwarden:matrix.org](https://matrix.to/#/#vaultwarden:matrix.org) room on Matrix. Feel free to join us!
|
||||
|
||||
### Sponsors
|
||||
Thanks for your contribution to the project!
|
||||
|
||||
<!--
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center">
|
||||
<a href="https://github.com/username">
|
||||
<img src="https://avatars.githubusercontent.com/u/725423?s=75&v=4" width="75px;" alt="username"/>
|
||||
<br />
|
||||
<sub><b>username</b></sub>
|
||||
</a>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
-->
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center">
|
||||
<a href="https://github.com/themightychris" style="width: 75px">
|
||||
<sub><b>Chris Alfano</b></sub>
|
||||
</a>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="center">
|
||||
<a href="https://github.com/numberly" style="width: 75px">
|
||||
<sub><b>Numberly</b></sub>
|
||||
</a>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
20
apps/bitwarden/data.yml
Normal file
@ -0,0 +1,20 @@
|
||||
name: Bitwarden
|
||||
tags:
|
||||
- 工具
|
||||
title: 一个开源的密码管理服务
|
||||
type: 工具
|
||||
description: 一个开源的密码管理服务
|
||||
additionalProperties:
|
||||
key: bitwarden
|
||||
name: Bitwarden
|
||||
tags:
|
||||
- Tool
|
||||
shortDescZh: 一个开源的密码管理服务
|
||||
shortDescEn: An open source password management service
|
||||
type: tool
|
||||
crossVersionUpdate: true
|
||||
limit: 0
|
||||
recommend: 0
|
||||
website: https://bitwarden.com/
|
||||
github: https://github.com/dani-garcia/vaultwarden
|
||||
document: https://github.com/dani-garcia/vaultwarden/wiki
|
BIN
apps/bitwarden/logo.png
Normal file
After Width: | Height: | Size: 16 KiB |
98
apps/lsky-pro/README.md
Normal file
@ -0,0 +1,98 @@
|
||||
<img align="right" width="100" src="https://avatars.githubusercontent.com/u/100565733?s=200" alt="Lsky Pro Logo"/>
|
||||
|
||||
<h1 align="left"><a href="https://www.lsky.pro">Lsky Pro</a></h1>
|
||||
|
||||
☁ Your photo album on the cloud.
|
||||
|
||||
[![PHP](https://img.shields.io/badge/PHP->=8.0-orange.svg)](http://php.net)
|
||||
[![Release](https://img.shields.io/github/v/release/lsky-org/lsky-pro)](https://github.com/lsky-org/lsky-pro/releases)
|
||||
[![Issues](https://img.shields.io/github/issues/lsky-org/lsky-pro)](https://github.com/lsky-org/lsky-pro/issues)
|
||||
[![Code size](https://img.shields.io/github/languages/code-size/lsky-org/lsky-pro?color=blueviolet)](https://github.com/lsky-org/lsky-pro)
|
||||
[![Repo size](https://img.shields.io/github/repo-size/lsky-org/lsky-pro?color=eb56fd)](https://github.com/lsky-org/lsky-pro)
|
||||
[![Last commit](https://img.shields.io/github/last-commit/lsky-org/lsky-pro/dev)](https://github.com/lsky-org/lsky-pro/commits/dev)
|
||||
[![License](https://img.shields.io/badge/license-GPL_V3.0-yellowgreen.svg)](https://github.com/lsky-org/lsky-pro/blob/master/LICENSE)
|
||||
|
||||
[官网](https://www.lsky.pro) ·
|
||||
[文档](https://docs.lsky.pro) ·
|
||||
[社区](https://github.com/lsky-org/lsky-pro/discussions) ·
|
||||
[演示](https://pic.vv1234.cn) ·
|
||||
[Telegram 群组](https://t.me/lsky_pro)
|
||||
|
||||
> master 分支为未安装三方拓展的版本,通常包含了最新未发布版本的一些实验性新特性和修复补丁,正式版本请点击 [这里](https://github.com/lsky-org/lsky-pro/releases) 下载。
|
||||
> 发现 bug 请提交 [issues](https://github.com/lsky-org/lsky-pro/issues) (提问前建议阅读[提问的智慧](https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way/blob/main/README-zh_CN.md))
|
||||
> 有任何想法、建议、或分享,请移步 [社区](https://github.com/lsky-org/lsky-pro/discussions)
|
||||
|
||||
![看不见图片请使用科学上网](https://user-images.githubusercontent.com/22728201/157242302-bfbd04a0-fb30-4241-800e-cc2b1dad9b19.png)
|
||||
![看不见图片请使用科学上网](https://user-images.githubusercontent.com/22728201/157242314-5716d578-fee5-4083-8d91-0d98cb2545d9.png)
|
||||
|
||||
### 📌 TODO
|
||||
* [x] 支持`本地`等多种第三方云储存 `AWS S3`、`阿里云 OSS`、`腾讯云 COS`、`七牛云`、`又拍云`、`SFTP`、`FTP`、`WebDav`、`Minio`
|
||||
* [x] 多种数据库驱动支持,`MySQL 5.7+`、`PostgreSQL 9.6+`、`SQLite 3.8.8+`、`SQL Server 2017+`
|
||||
* [x] 支持配置使用多种缓存驱动,`Memcached`、`Redis`、`DynamoDB`、等其他关系型数据库,默认以文件的方式缓存
|
||||
* [x] 多图上传、拖拽上传、粘贴上传、动态设置策略上传、复制、一键复制链接
|
||||
* [x] 强大的图片管理功能,瀑布流展示,支持鼠标右键、单选多选、重命名等操作
|
||||
* [x] 自由度极高的角色组配置,可以为每个组配置多个储存策略,同时储存策略可以配置多个角色组
|
||||
* [x] 可针对角色组设置上传文件、文件夹路径命名规则、上传频率限制、图片审核等功能
|
||||
* [x] 支持图片水印、文字水印、水印平铺、设置水印位置、X/y 轴偏移量设置、旋转角度等
|
||||
* [x] 支持通过接口上传、管理图片、管理相册
|
||||
* [x] 支持在线增量更新、跨版本更新
|
||||
* [x] 图片广场
|
||||
|
||||
### 🛠 安装要求
|
||||
- PHP >= 8.0.2
|
||||
- BCMath PHP 扩展
|
||||
- Ctype PHP 扩展
|
||||
- DOM PHP 拓展
|
||||
- Fileinfo PHP 扩展
|
||||
- JSON PHP 扩展
|
||||
- Mbstring PHP 扩展
|
||||
- OpenSSL PHP 扩展
|
||||
- PDO PHP 扩展
|
||||
- Tokenizer PHP 扩展
|
||||
- XML PHP 扩展
|
||||
- Imagick 拓展
|
||||
- exec、shell_exec 函数
|
||||
- readlink、symlink 函数
|
||||
- putenv、getenv 函数
|
||||
- chmod、chown、fileperms 函数
|
||||
|
||||
### 😋 鸣谢
|
||||
- [Laravel](https://laravel.com)
|
||||
- [Tailwindcss](https://tailwindcss.com)
|
||||
- [Fontawesome](https://fontawesome.com)
|
||||
- [Echarts](https://echarts.apache.org)
|
||||
- [Intervention/image](https://github.com/Intervention/image)
|
||||
- [league/flysystem](https://flysystem.thephpleague.com)
|
||||
- [overtrue](https://github.com/overtrue)
|
||||
- [Jquery](https://jquery.com)
|
||||
- [jQuery-File-Upload](https://github.com/blueimp/jQuery-File-Upload)
|
||||
- [Alpinejs](https://alpinejs.dev/)
|
||||
- [Viewer.js](https://github.com/fengyuanchen/viewerjs)
|
||||
- [DragSelect](https://github.com/ThibaultJanBeyer/DragSelect)
|
||||
- [Justified-Gallery](https://github.com/miromannino/Justified-Gallery)
|
||||
- [Clipboard.js](https://github.com/zenorocha/clipboard.js)
|
||||
|
||||
### 💰 捐赠
|
||||
Lsky Pro 的开发和更新等,都是作者在业余时间独立开发,并免费开源使用,如果您认可我的作品,并且觉得对你有所帮助我愿意接受来自各方面的捐赠😃。
|
||||
<table width="100%">
|
||||
<tr>
|
||||
<th>支付宝</th>
|
||||
<th>微信</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><img alt="看不见图片请使用科学上网" src="https://raw.githubusercontent.com/lsky-org/lsky-pro/82988ebe2edd32264d609b26bf9132b3dce7c39e/public/static/app/images/demo/alipay.png"></td>
|
||||
<td><img alt="看不见图片请使用科学上网" src="https://raw.githubusercontent.com/lsky-org/lsky-pro/82988ebe2edd32264d609b26bf9132b3dce7c39e/public/static/app/images/demo/wechat.jpeg"></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
### 🤩 Stargazers over time
|
||||
[![Stargazers over time](https://starchart.cc/lsky-org/lsky-pro.svg)](https://starchart.cc/lsky-org/lsky-pro)
|
||||
|
||||
### 📧 联系我
|
||||
- Email: i@wispx.cn
|
||||
|
||||
### 📃 开源许可
|
||||
[GPL 3.0](https://opensource.org/licenses/GPL-3.0)
|
||||
|
||||
Copyright (c) 2018-present Lsky Pro.
|
||||
|
20
apps/lsky-pro/data.yml
Normal file
@ -0,0 +1,20 @@
|
||||
name: Lsky-pro
|
||||
tags:
|
||||
- 工具
|
||||
title: Lsky Pro 是一个用于在线上传、管理图片的图床程序
|
||||
type: 工具
|
||||
description: Lsky Pro 是一个用于在线上传、管理图片的图床程序
|
||||
additionalProperties:
|
||||
key: lsky-pro
|
||||
name: Lsky-pro
|
||||
tags:
|
||||
- Tool
|
||||
shortDescZh: Lsky Pro 是一个用于在线上传、管理图片的图床程序
|
||||
shortDescEn: Lsky Pro is an image bed program for uploading and managing images online
|
||||
type: tool
|
||||
crossVersionUpdate: true
|
||||
limit: 0
|
||||
recommend: 0
|
||||
website: https://hub.docker.com/r/halcyonazure/lsky-pro-docker
|
||||
github: https://github.com/lsky-org/lsky-pro
|
||||
document: https://docs.lsky.pro/
|
17
apps/lsky-pro/latest/data.yml
Normal file
@ -0,0 +1,17 @@
|
||||
additionalProperties:
|
||||
formFields:
|
||||
- default: 40027
|
||||
edit: true
|
||||
envKey: PANEL_APP_PORT_HTTP
|
||||
labelEn: Port
|
||||
labelZh: 端口
|
||||
required: true
|
||||
rule: paramPort
|
||||
type: number
|
||||
- default: ./data
|
||||
edit: true
|
||||
envKey: DATA_PATH
|
||||
labelEn: Data folder path
|
||||
labelZh: 数据文件夹路径
|
||||
required: true
|
||||
type: text
|
20
apps/lsky-pro/latest/docker-compose.yml
Normal file
@ -0,0 +1,20 @@
|
||||
version: "3"
|
||||
services:
|
||||
lskypro:
|
||||
container_name: ${CONTAINER_NAME}
|
||||
restart: always
|
||||
networks:
|
||||
- 1panel-network
|
||||
volumes:
|
||||
- "${DATA_PATH}:/var/www/html/"
|
||||
ports:
|
||||
- "${PANEL_APP_PORT_HTTP}:8089"
|
||||
environment:
|
||||
- "WEB_PORT=8089"
|
||||
image: halcyonazure/lsky-pro-docker:latest
|
||||
labels:
|
||||
createdBy: "Apps"
|
||||
|
||||
networks:
|
||||
1panel-network:
|
||||
external: true
|
BIN
apps/lsky-pro/logo.png
Normal file
After Width: | Height: | Size: 18 KiB |
17
apps/memcached/1.6.19/data.yml
Normal file
@ -0,0 +1,17 @@
|
||||
additionalProperties:
|
||||
formFields:
|
||||
- default: 11211
|
||||
edit: true
|
||||
envKey: PANEL_APP_PORT_HTTP
|
||||
labelEn: Port
|
||||
labelZh: 端口
|
||||
required: true
|
||||
rule: paramPort
|
||||
type: number
|
||||
- default: '64'
|
||||
edit: true
|
||||
envKey: MEM_CACHED
|
||||
labelEn: Maximum memory usage(MB)
|
||||
labelZh: 内存最大占用量(MB)
|
||||
required: true
|
||||
type: number
|
16
apps/memcached/1.6.19/docker-compose.yml
Normal file
@ -0,0 +1,16 @@
|
||||
version: '3'
|
||||
services:
|
||||
memcached:
|
||||
container_name: ${CONTAINER_NAME}
|
||||
restart: always
|
||||
networks:
|
||||
- 1panel-network
|
||||
ports:
|
||||
- "${PANEL_APP_PORT_HTTP}:11211"
|
||||
command: memcached -m ${MEM_CACHED}
|
||||
image: "memcached:1.6.19-alpine3.17"
|
||||
labels:
|
||||
createdBy: "Apps"
|
||||
networks:
|
||||
1panel-network:
|
||||
external: true
|
54
apps/memcached/README.md
Normal file
@ -0,0 +1,54 @@
|
||||
# Memcached
|
||||
|
||||
Memcached is a high performance multithreaded event-based key/value cache
|
||||
store intended to be used in a distributed system.
|
||||
|
||||
See: https://memcached.org/about
|
||||
|
||||
A fun story explaining usage: https://memcached.org/tutorial
|
||||
|
||||
If you're having trouble, try the wiki: https://memcached.org/wiki
|
||||
|
||||
If you're trying to troubleshoot odd behavior or timeouts, see:
|
||||
https://memcached.org/timeouts
|
||||
|
||||
https://memcached.org/ is a good resource in general. Please use the mailing
|
||||
list to ask questions, github issues aren't seen by everyone!
|
||||
|
||||
## Dependencies
|
||||
|
||||
* libevent - https://www.monkey.org/~provos/libevent/ (libevent-dev)
|
||||
* libseccomp (optional, experimental, linux) - enables process restrictions for
|
||||
better security. Tested only on x86-64 architectures.
|
||||
* openssl (optional) - enables TLS support. need relatively up to date
|
||||
version. pkg-config is needed to find openssl dependencies (such as -lz).
|
||||
|
||||
## Environment
|
||||
|
||||
Be warned that the -k (mlockall) option to memcached might be
|
||||
dangerous when using a large cache. Just make sure the memcached machines
|
||||
don't swap. memcached does non-blocking network I/O, but not disk. (it
|
||||
should never go to disk, or you've lost the whole point of it)
|
||||
|
||||
## Build status
|
||||
|
||||
See https://build.memcached.org/ for multi-platform regression testing status.
|
||||
|
||||
## Bug reports
|
||||
|
||||
Feel free to use the issue tracker on github.
|
||||
|
||||
**If you are reporting a security bug** please contact a maintainer privately.
|
||||
We follow responsible disclosure: we handle reports privately, prepare a
|
||||
patch, allow notifications to vendor lists. Then we push a fix release and your
|
||||
bug can be posted publicly with credit in our release notes and commit
|
||||
history.
|
||||
|
||||
## Website
|
||||
|
||||
* https://www.memcached.org
|
||||
|
||||
## Contributing
|
||||
|
||||
See https://github.com/memcached/memcached/wiki/DevelopmentRepos
|
||||
|
20
apps/memcached/data.yml
Normal file
@ -0,0 +1,20 @@
|
||||
name: Memcached
|
||||
tags:
|
||||
- 工具
|
||||
title: Memcached是一套分布式的高速缓存系统
|
||||
type: 工具
|
||||
description: Memcached是一套分布式的高速缓存系统
|
||||
additionalProperties:
|
||||
key: memcached
|
||||
name: Memcached
|
||||
tags:
|
||||
- Tool
|
||||
shortDescZh: Memcached是一套分布式的高速缓存系统
|
||||
shortDescEn: Memcached is a distributed caching system
|
||||
type: tool
|
||||
crossVersionUpdate: true
|
||||
limit: 0
|
||||
recommend: 0
|
||||
website: https://memcached.org/
|
||||
github: https://github.com/memcached/memcached
|
||||
document: https://github.com/memcached/memcached/wiki
|
BIN
apps/memcached/logo.png
Normal file
After Width: | Height: | Size: 24 KiB |
35
apps/qiandao/20230618/data.yml
Normal file
@ -0,0 +1,35 @@
|
||||
additionalProperties:
|
||||
formFields:
|
||||
- default: 40022
|
||||
edit: true
|
||||
envKey: PANEL_APP_PORT_HTTP
|
||||
labelEn: Port
|
||||
labelZh: 端口
|
||||
required: true
|
||||
rule: paramPort
|
||||
type: number
|
||||
- default: ./data
|
||||
edit: true
|
||||
envKey: DATA_PATH
|
||||
labelEn: Data folder path
|
||||
labelZh: 数据文件夹路径
|
||||
required: true
|
||||
type: text
|
||||
- default: AESPWD
|
||||
envKey: AES_PWD
|
||||
labelEn: AES encryption key
|
||||
labelZh: AES加密密钥
|
||||
random: true
|
||||
required: true
|
||||
rule: paramCommon
|
||||
type: text
|
||||
- default: CKPWD
|
||||
envKey: COOKIE_PWD
|
||||
labelEn: COOKIE encryption key
|
||||
labelZh: COOKIE加密密钥
|
||||
random: true
|
||||
required: true
|
||||
rule: paramCommon
|
||||
type: text
|
||||
- default: http
|
||||
edit: true
|
153
apps/qiandao/20230618/docker-compose.yml
Normal file
@ -0,0 +1,153 @@
|
||||
version: "3"
|
||||
services:
|
||||
qiandao:
|
||||
container_name: ${CONTAINER_NAME}
|
||||
restart: always
|
||||
networks:
|
||||
- 1panel-network
|
||||
ports:
|
||||
- "${PANEL_APP_PORT_HTTP}:80"
|
||||
volumes:
|
||||
- "${DATA_PATH}:/usr/src/app/config"
|
||||
environment:
|
||||
# 监听地址
|
||||
# - BIND=0.0.0.0
|
||||
# 监听端口
|
||||
- PORT=80
|
||||
# 是否启用Debug模式
|
||||
# - QIANDAO_DEBUG=False
|
||||
# 任务定时执行方式,默认为Queue,可选Queue或Batch
|
||||
# - WORKER_METHOD=Queue
|
||||
# 是否启用多进程模式,Windows平台无效
|
||||
# - MULTI_PROCESS=False
|
||||
# 是否启用自动热加载,MULTI_PROCESS=True时无效
|
||||
- AUTO_RELOAD=False
|
||||
# 发送的邮件链接启用HTTPS,非框架前端使用HTTPS,如果前端需要HTTPS,请使用反向代理
|
||||
# - ENABLE_HTTPS=False
|
||||
# 指定访问域名,建议修改,否则通过邮件重置密码等功能无效
|
||||
# - DOMAIN=
|
||||
# AES加密密钥,强烈建议修改
|
||||
- AES_KEY=${AES_PWD}
|
||||
# cookie加密密钥,强烈建议修改
|
||||
- COOKIE_SECRET=${COOKIE_PWD}
|
||||
# Cookie在客户端中保留的天数
|
||||
# - COOKIE_DAY=5
|
||||
# 需要使用MySQL时设置为'mysql'
|
||||
- DB_TYPE=sqlite3
|
||||
# 需要使用MySQL时,设置为(mysql://用户名:密码@hostname:port/数据库名?auth_plugin=)
|
||||
# - JAWSDB_MARIA_URL=mysql://user:pass@localhost:3306/dbname\?auth_plugin=
|
||||
# 是否启用SQLAlchmey的日志输出,默认为False
|
||||
# - QIANDAO_SQL_ECHO=False
|
||||
# SQLAlchmey日志名称,默认为'QD.sql_engine'
|
||||
# - QIANDAO_SQL_LOGGING_NAME=qiandao.sql
|
||||
# SQLAlchmey日志级别,默认为'Warning'
|
||||
# - QIANDAO_SQL_LOGGING_LEVEL=WARNING
|
||||
# 是否启用SQLAlchmey的连接池日志输出,默认为True
|
||||
# - QIANDAO_SQL_ECHO_POOL=True
|
||||
# SQLAlchmey连接池日志名称,默认为'QD.sql_pool'
|
||||
# - QIANDAO_SQL_LOGGING_POOL_NAME=QD.sql_pool
|
||||
# SQLAlchmey连接池日志级别,默认为'Warning'
|
||||
# - QIANDAO_SQL_LOGGING_POOL_LEVEL=Warning
|
||||
# SQLAlchmey连接池大小,默认为10
|
||||
# - QIANDAO_SQL_POOL_SIZE=5
|
||||
# SQLAlchmey连接池最大溢出,默认为50
|
||||
# - QIANDAO_SQL_MAX_OVERFLOW=10
|
||||
# 是否在连接池获取连接前,先ping一下,默认为True
|
||||
# - QIANDAO_SQL_POOL_PRE_PING=True
|
||||
# SQLAlchmey连接池回收时间,默认为3600a
|
||||
# - QIANDAO_SQL_POOL_RECYCLE=3600
|
||||
# SQLAlchmey连接池超时时间,默认为60
|
||||
# - QIANDAO_SQL_POOL_TIMEOUT=60
|
||||
# SQLAlchmey是否使用LIFO算法,默认为True
|
||||
# - QIANDAO_SQL_POOL_USE_LIFO=True
|
||||
# 需要使用Redis或RedisCloud时,设置为http://rediscloud:密码@hostname:port
|
||||
# - REDISCLOUD_URL=http://rediscloud:密码@hostname:port
|
||||
# 默认为1
|
||||
# - REDIS_DB_INDEX=1
|
||||
# (限Redis连接已开启)登录用户或IP在1小时内分数=操作失败次数*相应惩罚分值,分数达到evil上限后自动封禁直至下一小时周期
|
||||
# - QIANDAO_EVIL=1000
|
||||
# 是否关闭本机私有IP地址用户及Localhost_API请求的evil限制
|
||||
# - EVIL_PASS_LAN_IP=True
|
||||
# 是否启用在控制台日志中打印Exception的TraceBack信息
|
||||
# - TRACEBACK_PRINT=False
|
||||
# 默认为push_pic.png
|
||||
# - PUSH_PIC_URL=https://fastly.jsdelivr.net/gh/qd-today/qd@master/web/static/img/push_pic.png
|
||||
# 是否允许开启定期推送QD任务日志,默认为True
|
||||
# - PUSH_BATCH_SW=True
|
||||
# 邮箱SMTP服务器
|
||||
# - MAIL_SMTP=''
|
||||
# 邮箱SMTP服务器端口
|
||||
# - MAIL_PORT=465
|
||||
# 邮箱用户名
|
||||
# - MAIL_USER=''
|
||||
# 邮箱密码
|
||||
# - MAIL_PASSWORD=''
|
||||
# 发送时使用的邮箱,默认与MAIL_USER相同
|
||||
# - MAIL_FROM=${MAIL_USER}
|
||||
# 邮箱域名,没啥用,使用的DOMAIN
|
||||
# - MAIL_DOMAIN=mail.qd.today
|
||||
# 全局代理域名列表,用"|"分隔
|
||||
# - PROXIES=''
|
||||
# 全局代理黑名单模式,默认不启用
|
||||
# "url"为网址匹配模式;"regexp"为正则表达式匹配模式
|
||||
# - PROXY_DIRECT_MODE=regexp
|
||||
# 全局代理黑名单匹配规则
|
||||
# - PROXY_DIRECT=(?xi)\A([a-z][a-z0-9+\-.]*://)?(0(.0){3}|127(.0){2}.1|localhost|\[::([\d]+)?\])(:[0-9]+)?
|
||||
# 是否启用Pycurl模组
|
||||
# - USE_PYCURL=True
|
||||
# 在Pycurl环境下部分请求可能导致Request错误时,自动修改冲突设置并重发请求
|
||||
# - ALLOW_RETRY=True
|
||||
# 通过Curl使用指定DNS进行解析(仅支持Pycurl环境),如8.8.8.8
|
||||
# - DNS_SERVER=''
|
||||
# 是否允许使用Curl进行Encoding操作
|
||||
# - CURL_ENCODING=True
|
||||
# 是否允许Curl使用Headers中自定义Content-Length请求
|
||||
# - CURL_CONTENT_LENGTH=True
|
||||
# 详见配置...
|
||||
# - NOT_RETRY_CODE=301|302|303|304|305|307|400|401|403|404|405|407|408|409|410|412|415|413|414|500|501|502|503|504|599
|
||||
# - EMPTY_RETRY=True
|
||||
# 第一个注册用户为管理员,False关闭
|
||||
- USER0ISADMIN=False
|
||||
# config目录下自定义ONNX文件名(不填 ".onnx" 后缀),多个onnx文件名用"|"分隔
|
||||
# - EXTRA_ONNX_NAME=''
|
||||
# config目录下自定义ONNX对应自定义charsets.json文件名(不填 ".json" 后缀),多个json文件名用"|"分隔
|
||||
# - EXTRA_CHARSETS_NAME=''
|
||||
# WebSocket ping间隔,单位为秒,默认为5s
|
||||
# - WS_PING_INTERVAL=5
|
||||
# WebSocket ping超时时间,单位为秒,默认为30s
|
||||
# - WS_PING_TIMEOUT=30
|
||||
# WebSocket单次接收最大消息大小,默认为10MB
|
||||
# - WS_MAX_MESSAGE_SIZE=10485760
|
||||
# WebSocket最大消息队列大小,默认为100
|
||||
# - WS_MAX_QUEUE_SIZE=100
|
||||
# WebSocket公共模板更新页面最大连接数,默认为30
|
||||
# - WS_MAX_CONNECTIONS_SUBSCRIBE=30
|
||||
# 订阅加速方式或地址,用于加速公共模板更新,仅适用于GitHub
|
||||
# - SUBSCRIBE_ACCELERATE_URL=jsdelivr_cdn
|
||||
- GZIP=True
|
||||
# - QUEUE_NUM=50
|
||||
- ACCESS_LOG=True
|
||||
# - PUSH_BATCH_DELTA=60
|
||||
# - QIANDAO_SQL_POOL_LOGGING_NAME=qiandao.sql.pool
|
||||
# - QIANDAO_SQL_POOL_LOGGING_LEVEL=WARNING
|
||||
# - QIANDAO_SQL_POOL_TIMEOUT=30
|
||||
# - PBKDF2_ITERATIONS=400
|
||||
# - CHECK_TASK_LOOP=500
|
||||
# - TASK_MAX_RETRY_COUNT=8
|
||||
# - DOWNLOAD_SIZE_LIMIT=5242880
|
||||
# - REQUEST_TIMEOUT=30.0
|
||||
# - CONNECT_TIMEOUT=30.0
|
||||
# - DELAY_MAX_TIMEOUT=29.9
|
||||
# - UNSAFE_EVAL_TIMEOUT=3.0
|
||||
# - NEW_TASK_DELAY=1
|
||||
# - MAIL_SSL=True
|
||||
# - MAILGUN_KEY=
|
||||
image: a76yyyy/qiandao:20230618
|
||||
# image: a76yyyy/qiandao:latest
|
||||
# image: a76yyyy/qiandao:lite-latest
|
||||
labels:
|
||||
createdBy: "Apps"
|
||||
|
||||
networks:
|
||||
1panel-network:
|
||||
external: true
|
134
apps/qiandao/README.md
Normal file
@ -0,0 +1,134 @@
|
||||
# 说明
|
||||
## 设置管理员
|
||||
- 1.先注册一个账户.
|
||||
- 2.进入容器运行以下命令
|
||||
|
||||
```
|
||||
python ./chrole.py your@email.address admin
|
||||
```
|
||||
- 3.需要先登出再登陆后才能获得完整管理员权限。
|
||||
|
||||
|
||||
# 原始相关
|
||||
<p align="center">
|
||||
<a href="https://github.com/qd-today/qd">
|
||||
<img style="border-radius:50%" width="150" src="https://fastly.jsdelivr.net/gh/qd-today/qd@master/web/static/img/icon.png">
|
||||
</a>
|
||||
</p>
|
||||
|
||||
<h1 align="center">QD for Python3</h1>
|
||||
|
||||
<div align="center">
|
||||
QD —— 一个<b>HTTP请求定时任务自动执行框架</b> base on HAR Editor and Tornado Server
|
||||
|
||||
[![HomePage][HomePage-image]][HomePage-url]
|
||||
[![Github][Github-image]][Github-url]
|
||||
[![Gitee][Gitee-image]][Gitee-url]
|
||||
[![license][github-license-image]][github-license-url]
|
||||
[![Build Image][workflow-image]][workflow-url]
|
||||
[![last commit][last-commit-image]][last-commit-url]
|
||||
[![commit activity][commit-activity-image]][commit-activity-url]
|
||||
[![docker version][docker-version-image]][docker-version-url]
|
||||
[![docker pulls][docker-pulls-image]][docker-pulls-url]
|
||||
[![docker stars][docker-stars-image]][docker-stars-url]
|
||||
[![docker image size][docker-image-size-image]][docker-image-size-url]
|
||||
![repo size][repo-size-image]
|
||||
![python version][python-version-image]
|
||||
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
|
||||
[![All Contributors](https://img.shields.io/badge/all_contributors-15-orange.svg?style=flat-square)](#contributors-)
|
||||
<!-- ALL-CONTRIBUTORS-BADGE:END -->
|
||||
|
||||
[HomePage-image]: https://img.shields.io/badge/HomePage-qd--today-brightgreen
|
||||
[HomePage-url]: https://qiandao.a76yyyy.cn
|
||||
[Github-image]: https://img.shields.io/static/v1?label=Github&message=qd-today&color=brightgreen
|
||||
[Github-url]: https://github.com/qd-today/qd/
|
||||
[Gitee-image]: https://img.shields.io/static/v1?label=Gitee&message=a76yyyy&color=brightgreen
|
||||
[Gitee-url]: https://gitee.com/qd-today/qd/
|
||||
[github-license-image]: https://img.shields.io/github/license/qd-today/qd
|
||||
[github-license-url]: https://github.com/qd-today/qd/blob/master/LICENSE
|
||||
[last-commit-image]: https://img.shields.io/github/last-commit/qd-today/qd
|
||||
[last-commit-url]: https://github.com/qd-today/qd/
|
||||
[commit-activity-image]: https://img.shields.io/github/commit-activity/m/qd-today/qd
|
||||
[commit-activity-url]: https://github.com/qd-today/qd/
|
||||
[docker-version-image]: https://img.shields.io/docker/v/qdtoday/qd?style=flat
|
||||
[docker-version-url]: https://hub.docker.com/r/qdtoday/qd/tags?page=1&ordering=last_updated
|
||||
[docker-pulls-image]: https://img.shields.io/docker/pulls/qdtoday/qd?style=flat
|
||||
[docker-pulls-url]: https://hub.docker.com/r/qdtoday/qd
|
||||
[docker-stars-image]: https://img.shields.io/docker/stars/qdtoday/qd?style=flat
|
||||
[docker-stars-url]: https://hub.docker.com/r/qdtoday/qd
|
||||
[docker-image-size-image]: https://img.shields.io/docker/image-size/qdtoday/qd?style=flat
|
||||
[docker-image-size-url]: https://hub.docker.com/r/qdtoday/qd
|
||||
[repo-size-image]: https://img.shields.io/github/repo-size/qd-today/qd
|
||||
[python-version-image]: https://img.shields.io/github/pipenv/locked/python-version/qd-today/qd
|
||||
[workflow-image]: https://github.com/qd-today/qd/actions/workflows/Publish%20Package.yml/badge.svg
|
||||
[workflow-url]: https://github.com/qd-today/qd/actions/workflows/Publish%20Package.yml
|
||||
|
||||
</div>
|
||||
|
||||
<p align="center">
|
||||
<img width="45%" style="border:solid 1px #DCEBFB" src="https://fastly.jsdelivr.net/gh/qd-today/qd@master/web/docs/public/login.png" >
|
||||
<img width="45%" style="border:solid 1px #DCEBFB" src="https://fastly.jsdelivr.net/gh/qd-today/qd@master/web/docs/public/index.png">
|
||||
</p>
|
||||
|
||||
操作说明
|
||||
==========
|
||||
|
||||
请参阅 **[使用指南](https://qd-today.github.io/qd/zh_CN/)**
|
||||
|
||||
更新日志
|
||||
===========
|
||||
|
||||
详见 **[CHANGELOG.md](./CHANGELOG.md)**
|
||||
|
||||
维护项目精力有限, 仅保证对 Chrome 浏览器的支持。如果测试了其他浏览器可以 Pull Request。
|
||||
|
||||
许可
|
||||
===========
|
||||
|
||||
[MIT](https://fastly.jsdelivr.net/gh/qd-today/qd@master/LICENSE) 许可协议
|
||||
|
||||
致谢
|
||||
===========
|
||||
|
||||
## Contributors ✨
|
||||
|
||||
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
|
||||
|
||||
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
|
||||
<!-- prettier-ignore-start -->
|
||||
<!-- markdownlint-disable -->
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center"><a href="http://www.a76yyyy.cn"><img src="https://avatars.githubusercontent.com/u/56478790?v=4?s=100" width="100px;" alt=""/><br /><sub><b>a76yyyy</b></sub></a><br /><a href="#design-a76yyyy" title="Design">🎨</a> <a href="https://github.com/qd-today/qd/commits?author=a76yyyy" title="Code">💻</a> <a href="#maintenance-a76yyyy" title="Maintenance">🚧</a></td>
|
||||
<td align="center"><a href="http://binux.me/"><img src="https://avatars.githubusercontent.com/u/646451?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Roy Binux</b></sub></a><br /><a href="#design-Binux" title="Design">🎨</a> <a href="https://github.com/qd-today/qd/commits?author=Binux" title="Code">💻</a> <a href="#maintenance-Binux" title="Maintenance">🚧</a></td>
|
||||
<td align="center"><a href="https://github.com/AragonSnow"><img src="https://avatars.githubusercontent.com/u/22835918?v=4?s=100" width="100px;" alt=""/><br /><sub><b>AragonSnow</b></sub></a><br /><a href="https://github.com/qd-today/qd/commits?author=AragonSnow" title="Code">💻</a> <a href="#design-AragonSnow" title="Design">🎨</a> <a href="#maintenance-AragonSnow" title="Maintenance">🚧</a></td>
|
||||
<td align="center"><a href="https://www.quchao.net"><img src="https://avatars.githubusercontent.com/u/36469805?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Mark</b></sub></a><br /><a href="#design-Mark-1215" title="Design">🎨</a> <a href="#blog-Mark-1215" title="Blogposts">📝</a> <a href="#example-Mark-1215" title="Examples">💡</a> <a href="https://github.com/qd-today/qd/commits?author=Mark-1215" title="Documentation">📖</a></td>
|
||||
<td align="center"><a href="https://github.com/cdpidan"><img src="https://avatars.githubusercontent.com/u/8141453?v=4?s=100" width="100px;" alt=""/><br /><sub><b>pidan</b></sub></a><br /><a href="#design-cdpidan" title="Design">🎨</a></td>
|
||||
<td align="center"><a href="https://buzhibujue.cf"><img src="https://avatars.githubusercontent.com/u/24644841?v=4?s=100" width="100px;" alt=""/><br /><sub><b>buzhibujue</b></sub></a><br /><a href="https://github.com/qd-today/qd/commits?author=buzhibujuelb" title="Code">💻</a></td>
|
||||
<td align="center"><a href="https://github.com/billypon"><img src="https://avatars.githubusercontent.com/u/1763302?v=4?s=100" width="100px;" alt=""/><br /><sub><b>billypon</b></sub></a><br /><a href="https://github.com/qd-today/qd/commits?author=billypon" title="Code">💻</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="center"><a href="http://www.lingyan8.com"><img src="https://avatars.githubusercontent.com/u/19186382?v=4?s=100" width="100px;" alt=""/><br /><sub><b>acooler15</b></sub></a><br /><a href="https://github.com/qd-today/qd/commits?author=acooler15" title="Code">💻</a> <a href="#maintenance-acooler15" title="Maintenance">🚧</a></td>
|
||||
<td align="center"><a href="https://github.com/aa889788"><img src="https://avatars.githubusercontent.com/u/16019986?v=4?s=100" width="100px;" alt=""/><br /><sub><b>shxyke</b></sub></a><br /><a href="https://github.com/qd-today/qd/commits?author=aa889788" title="Code">💻</a></td>
|
||||
<td align="center"><a href="https://github.com/gxitm"><img src="https://avatars.githubusercontent.com/u/2405087?v=4?s=100" width="100px;" alt=""/><br /><sub><b>xiaoxiao</b></sub></a><br /><a href="https://github.com/qd-today/qd/commits?author=gxitm" title="Code">💻</a></td>
|
||||
<td align="center"><a href="https://blog.hicasper.com"><img src="https://avatars.githubusercontent.com/u/25276620?v=4?s=100" width="100px;" alt=""/><br /><sub><b>hiCasper</b></sub></a><br /><a href="https://github.com/qd-today/qd/commits?author=hiCasper" title="Code">💻</a></td>
|
||||
<td align="center"><a href="https://github.com/ckx000"><img src="https://avatars.githubusercontent.com/u/5800591?v=4?s=100" width="100px;" alt=""/><br /><sub><b>旋子</b></sub></a><br /><a href="https://github.com/qd-today/qd/commits?author=ckx000" title="Code">💻</a></td>
|
||||
<td align="center"><a href="https://github.com/chen8945"><img src="https://avatars.githubusercontent.com/u/44148812?v=4?s=100" width="100px;" alt=""/><br /><sub><b>chen8945</b></sub></a><br /><a href="https://github.com/qd-today/qd/commits?author=chen8945" title="Code">💻</a></td>
|
||||
<td align="center"><a href="https://github.com/seiuneko"><img src="https://avatars.githubusercontent.com/u/25706824?v=4?s=100" width="100px;" alt=""/><br /><sub><b>seiuneko</b></sub></a><br /><a href="https://github.com/qd-today/qd/commits?author=seiuneko" title="Code">💻</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="center"><a href="https://github.com/powersee"><img src="https://avatars.githubusercontent.com/u/38074760?v=4?s=100" width="100px;" alt=""/><br /><sub><b>powersee</b></sub></a><br /><a href="https://github.com/qd-today/qd/commits?author=powersee" title="Code">💻</a></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<!-- markdownlint-restore -->
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
<!-- ALL-CONTRIBUTORS-LIST:END -->
|
||||
|
||||
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
|
||||
|
||||
Stargazers over time
|
||||
===========
|
||||
|
||||
[![Stargazers over time](https://starchart.cc/qd-today/qd.svg)](https://starchart.cc/qd-today/qd)
|
20
apps/qiandao/data.yml
Normal file
@ -0,0 +1,20 @@
|
||||
name: QianDao
|
||||
tags:
|
||||
- 工具
|
||||
title: 一个HTTP请求定时任务自动执行框架
|
||||
type: 工具
|
||||
description: 一个HTTP请求定时任务自动执行框架
|
||||
additionalProperties:
|
||||
key: qiandao
|
||||
name: QianDao
|
||||
tags:
|
||||
- Tool
|
||||
shortDescZh: 一个HTTP请求定时任务自动执行框架
|
||||
shortDescEn: An HTTP request timed task automation framework
|
||||
type: tool
|
||||
crossVersionUpdate: true
|
||||
limit: 0
|
||||
recommend: 0
|
||||
website: https://hub.docker.com/r/a76yyyy/qiandao
|
||||
github: https://github.com/qiandao-today/qiandao
|
||||
document: https://qiandao-today.github.io/qiandao/zh_CN/
|
BIN
apps/qiandao/logo.png
Normal file
After Width: | Height: | Size: 16 KiB |
241
apps/rustdesk/README.md
Normal file
@ -0,0 +1,241 @@
|
||||
# 本应用相关
|
||||
|
||||
# **注意事项**
|
||||
- 运行完容器后需要获取当前数据目录"./data/hbbs"下的key,方便客户端使用。
|
||||
|
||||
```
|
||||
# 面板的话在文件管理里查看即可
|
||||
# 终端的话输入以下获得
|
||||
cat ./data/hbbs/id_ed25519.pub
|
||||
```
|
||||
|
||||
- 如果要更改key,请删除"./data/hbbs"和"./data/hbbr"文件夹下的"id_ed25519"和"id_ed25519.pub"文件并重新启动 hbbs/hbbr,hbbs将会产生新的密钥对。
|
||||
|
||||
# 原项目说明
|
||||
|
||||
<p align="center">
|
||||
<img src="https://github.com/rustdesk/rustdesk/raw/master/res/logo-header.svg" alt="RustDesk - Your remote desktop"><br>
|
||||
<a href="#免费公共服务器">服务器</a> •
|
||||
<a href="#基本构建步骤">编译</a> •
|
||||
<a href="#使用Docker编译">Docker</a> •
|
||||
<a href="#文件结构">结构</a> •
|
||||
<a href="#截图">截图</a><br>
|
||||
[<a href="../README.md">English</a>] | [<a href="README-UA.md">Українська</a>] | [<a href="README-CS.md">česky</a>] | [<a href="README-HU.md">Magyar</a>] | [<a href="README-ES.md">Español</a>] | [<a href="README-FA.md">فارسی</a>] | [<a href="README-FR.md">Français</a>] | [<a href="README-DE.md">Deutsch</a>] | [<a href="README-PL.md">Polski</a>] | [<a href="README-ID.md">Indonesian</a>] | [<a href="README-FI.md">Suomi</a>] | [<a href="README-ML.md">മലയാളം</a>] | [<a href="README-JP.md">日本語</a>] | [<a href="README-NL.md">Nederlands</a>] | [<a href="README-IT.md">Italiano</a>] | [<a href="README-RU.md">Русский</a>] | [<a href="README-PTBR.md">Português (Brasil)</a>] | [<a href="README-EO.md">Esperanto</a>] | [<a href="README-KR.md">한국어</a>] | [<a href="README-AR.md">العربي</a>] | [<a href="README-VN.md">Tiếng Việt</a>] | [<a href="README-GR.md">Ελληνικά</a>]<br>
|
||||
</p>
|
||||
|
||||
Chat with us: [知乎](https://www.zhihu.com/people/rustdesk) | [Discord](https://discord.gg/nDceKgxnkV) | [Reddit](https://www.reddit.com/r/rustdesk)
|
||||
|
||||
[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/I2I04VU09)
|
||||
|
||||
远程桌面软件,开箱即用,无需任何配置。您完全掌控数据,不用担心安全问题。您可以使用我们的注册/中继服务器,
|
||||
或者[自己设置](https://rustdesk.com/server),
|
||||
亦或者[开发您的版本](https://github.com/rustdesk/rustdesk-server-demo)。
|
||||
|
||||
欢迎大家贡献代码, 请看 [`docs/CONTRIBUTING.md`](CONTRIBUTING.md).
|
||||
|
||||
[**可执行程序下载**](https://github.com/rustdesk/rustdesk/releases)
|
||||
|
||||
## 免费的公共服务器
|
||||
|
||||
以下是您可以使用的、免费的、会随时更新的公共服务器列表,在国内也许网速会很慢或者无法访问。
|
||||
|
||||
| Location | Vendor | Specification |
|
||||
| --------- | ------------- | ------------------ |
|
||||
| Seoul | AWS lightsail | 1 vCPU / 0.5GB RAM |
|
||||
| Germany | Hetzner | 2 vCPU / 4GB RAM |
|
||||
| Germany | Codext | 4 vCPU / 8GB RAM |
|
||||
| Finland (Helsinki) | 0x101 Cyber Security | 4 vCPU / 8GB RAM |
|
||||
| USA (Ashburn) | 0x101 Cyber Security | 4 vCPU / 8GB RAM |
|
||||
|
||||
## 依赖
|
||||
|
||||
桌面版本界面使用[sciter](https://sciter.com/), 请自行下载。
|
||||
|
||||
[Windows](https://raw.githubusercontent.com/c-smile/sciter-sdk/master/bin.win/x64/sciter.dll) |
|
||||
[Linux](https://raw.githubusercontent.com/c-smile/sciter-sdk/master/bin.lnx/x64/libsciter-gtk.so) |
|
||||
[macOS](https://raw.githubusercontent.com/c-smile/sciter-sdk/master/bin.osx/libsciter.dylib)
|
||||
|
||||
移动版本使用Flutter,未来会将桌面版本从Sciter迁移到Flutter。
|
||||
|
||||
## 基本构建步骤
|
||||
|
||||
- 请准备好 Rust 开发环境和 C++编译环境
|
||||
|
||||
- 安装[vcpkg](https://github.com/microsoft/vcpkg), 正确设置`VCPKG_ROOT`环境变量
|
||||
|
||||
- Windows: vcpkg install libvpx:x64-windows-static libyuv:x64-windows-static opus:x64-windows-static
|
||||
- Linux/Osx: vcpkg install libvpx libyuv opus
|
||||
|
||||
- 运行 `cargo run`
|
||||
|
||||
## [构建](https://rustdesk.com/docs/en/dev/build/)
|
||||
|
||||
## 在 Linux 上编译
|
||||
|
||||
### Ubuntu 18 (Debian 10)
|
||||
|
||||
```sh
|
||||
sudo apt install -y g++ gcc git curl wget nasm yasm libgtk-3-dev clang libxcb-randr0-dev libxdo-dev libxfixes-dev libxcb-shape0-dev libxcb-xfixes0-dev libasound2-dev libpulse-dev cmake
|
||||
```
|
||||
|
||||
### Fedora 28 (CentOS 8)
|
||||
|
||||
```sh
|
||||
sudo yum -y install gcc-c++ git curl wget nasm yasm gcc gtk3-devel clang libxcb-devel libxdo-devel libXfixes-devel pulseaudio-libs-devel cmake alsa-lib-devel
|
||||
```
|
||||
|
||||
### Arch (Manjaro)
|
||||
|
||||
```sh
|
||||
sudo pacman -Syu --needed unzip git cmake gcc curl wget yasm nasm zip make pkg-config clang gtk3 xdotool libxcb libxfixes alsa-lib pipewire
|
||||
```
|
||||
|
||||
### 安装 vcpkg
|
||||
|
||||
```sh
|
||||
git clone https://github.com/microsoft/vcpkg
|
||||
cd vcpkg
|
||||
git checkout 2021.12.01
|
||||
cd ..
|
||||
vcpkg/bootstrap-vcpkg.sh
|
||||
export VCPKG_ROOT=$HOME/vcpkg
|
||||
vcpkg/vcpkg install libvpx libyuv opus
|
||||
```
|
||||
|
||||
### 修复 libvpx (仅仅针对 Fedora)
|
||||
|
||||
```sh
|
||||
cd vcpkg/buildtrees/libvpx/src
|
||||
cd *
|
||||
./configure
|
||||
sed -i 's/CFLAGS+=-I/CFLAGS+=-fPIC -I/g' Makefile
|
||||
sed -i 's/CXXFLAGS+=-I/CXXFLAGS+=-fPIC -I/g' Makefile
|
||||
make
|
||||
cp libvpx.a $HOME/vcpkg/installed/x64-linux/lib/
|
||||
cd
|
||||
```
|
||||
|
||||
### 构建
|
||||
|
||||
```sh
|
||||
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
|
||||
source $HOME/.cargo/env
|
||||
git clone https://github.com/rustdesk/rustdesk
|
||||
cd rustdesk
|
||||
mkdir -p target/debug
|
||||
wget https://raw.githubusercontent.com/c-smile/sciter-sdk/master/bin.lnx/x64/libsciter-gtk.so
|
||||
mv libsciter-gtk.so target/debug
|
||||
cargo run
|
||||
```
|
||||
|
||||
### 把 Wayland 修改成 X11 (Xorg)
|
||||
|
||||
RustDesk 暂时不支持 Wayland,不过正在积极开发中。
|
||||
> [点我](https://docs.fedoraproject.org/en-US/quick-docs/configuring-xorg-as-default-gnome-session/)
|
||||
查看 如何将Xorg设置成默认的GNOME session
|
||||
|
||||
## 使用 Docker 编译
|
||||
|
||||
### 构建Docker容器
|
||||
|
||||
```sh
|
||||
git clone https://github.com/rustdesk/rustdesk # 克隆Github存储库
|
||||
cd rustdesk # 进入文件夹
|
||||
docker build -t "rustdesk-builder" . # 构建容器
|
||||
```
|
||||
请注意:
|
||||
* 针对国内网络访问问题,可以做以下几点优化:
|
||||
1. Dockerfile 中修改系统的源到国内镜像
|
||||
```
|
||||
在Dockerfile的RUN apt update之前插入两行:
|
||||
|
||||
RUN sed -i "s/deb.debian.org/mirrors.163.com/g" /etc/apt/sources.list
|
||||
RUN sed -i "s/security.debian.org/mirrors.163.com/g" /etc/apt/sources.list
|
||||
```
|
||||
|
||||
2. 修改容器系统中的 cargo 源,在`RUN ./rustup.sh -y`后插入下面代码:
|
||||
|
||||
```
|
||||
RUN echo '[source.crates-io]' > ~/.cargo/config \
|
||||
&& echo 'registry = "https://github.com/rust-lang/crates.io-index"' >> ~/.cargo/config \
|
||||
&& echo '# 替换成你偏好的镜像源' >> ~/.cargo/config \
|
||||
&& echo "replace-with = 'sjtu'" >> ~/.cargo/config \
|
||||
&& echo '# 上海交通大学' >> ~/.cargo/config \
|
||||
&& echo '[source.sjtu]' >> ~/.cargo/config \
|
||||
&& echo 'registry = "https://mirrors.sjtug.sjtu.edu.cn/git/crates.io-index"' >> ~/.cargo/config \
|
||||
&& echo '' >> ~/.cargo/config
|
||||
```
|
||||
|
||||
3. Dockerfile 中加入代理的 env
|
||||
|
||||
```
|
||||
在User root后插入两行
|
||||
|
||||
ENV http_proxy=http://host:port
|
||||
ENV https_proxy=http://host:port
|
||||
```
|
||||
|
||||
4. docker build 命令后面加上 proxy 参数
|
||||
|
||||
```
|
||||
docker build -t "rustdesk-builder" . --build-arg http_proxy=http://host:port --build-arg https_proxy=http://host:port
|
||||
```
|
||||
|
||||
### 构建RustDesk程序
|
||||
容器构建完成后,运行下列指令以完成对RustDesk应用程序的构建:
|
||||
|
||||
```sh
|
||||
docker run --rm -it -v $PWD:/home/user/rustdesk -v rustdesk-git-cache:/home/user/.cargo/git -v rustdesk-registry-cache:/home/user/.cargo/registry -e PUID="$(id -u)" -e PGID="$(id -g)" rustdesk-builder
|
||||
```
|
||||
|
||||
请注意:
|
||||
* 因为需要缓存依赖项,首次构建一般很慢(国内网络会经常出现拉取失败,可以多试几次)。
|
||||
* 如果您需要添加不同的构建参数,可以在指令末尾的`<OPTIONAL-ARGS>` 位置进行修改。例如构建一个"Release"版本,在指令后面加上` --release`即可。
|
||||
* 如果出现以下的提示,则是无权限问题,可以尝试把`-e PUID="$(id -u)" -e PGID="$(id -g)"`参数去掉。
|
||||
```
|
||||
usermod: user user is currently used by process 1
|
||||
groupmod: Permission denied.
|
||||
groupmod: cannot lock /etc/group; try again later.
|
||||
```
|
||||
> **原因:** 容器的entrypoint脚本会检测UID和GID,在度判和给定的环境变量的不一致时,会强行修改user的UID和GID并重新运行。但在重启后读不到环境中的UID和GID,然后再次进入判错重启环节
|
||||
|
||||
|
||||
### 运行RustDesk程序
|
||||
|
||||
生成的可执行程序在target目录下,可直接通过指令运行调试(Debug)版本的RustDesk:
|
||||
```sh
|
||||
target/debug/rustdesk
|
||||
```
|
||||
|
||||
或者您想运行发行(Release)版本:
|
||||
|
||||
```sh
|
||||
target/release/rustdesk
|
||||
```
|
||||
|
||||
请注意:
|
||||
* 请保证您运行的目录是在RustDesk库的根目录内,否则软件会读不到文件。
|
||||
* `install`、`run`等Cargo的子指令在容器内不可用,宿主机才行。
|
||||
|
||||
## 文件结构
|
||||
|
||||
- **[libs/hbb_common](https://github.com/rustdesk/rustdesk/tree/master/libs/hbb_common)**: 视频编解码, 配置, tcp/udp 封装, protobuf, 文件传输相关文件系统操作函数, 以及一些其他实用函数
|
||||
- **[libs/scrap](https://github.com/rustdesk/rustdesk/tree/master/libs/scrap)**: 屏幕截取
|
||||
- **[libs/enigo](https://github.com/rustdesk/rustdesk/tree/master/libs/enigo)**: 平台相关的鼠标键盘输入
|
||||
- **[src/ui](https://github.com/rustdesk/rustdesk/tree/master/src/ui)**: GUI
|
||||
- **[src/server](https://github.com/rustdesk/rustdesk/tree/master/src/server)**: 被控端服务音频、剪切板、输入、视频服务、网络连接的实现
|
||||
- **[src/client.rs](https://github.com/rustdesk/rustdesk/tree/master/src/client.rs)**: 控制端
|
||||
- **[src/rendezvous_mediator.rs](https://github.com/rustdesk/rustdesk/tree/master/src/rendezvous_mediator.rs)**: 与[rustdesk-server](https://github.com/rustdesk/rustdesk-server)保持UDP通讯, 等待远程连接(通过打洞直连或者中继)
|
||||
- **[src/platform](https://github.com/rustdesk/rustdesk/tree/master/src/platform)**: 平台服务相关代码
|
||||
- **[flutter](https://github.com/rustdesk/rustdesk/tree/master/flutter)**: 移动版本的Flutter代码
|
||||
- **[flutter/web/js](https://github.com/rustdesk/rustdesk/tree/master/flutter/web/js)**: Flutter Web版本中的Javascript代码
|
||||
|
||||
## 截图
|
||||
|
||||
![image](https://user-images.githubusercontent.com/71636191/113112362-ae4deb80-923b-11eb-957d-ff88daad4f06.png)
|
||||
|
||||
![image](https://user-images.githubusercontent.com/71636191/113112619-f705a480-923b-11eb-911d-97e984ef52b6.png)
|
||||
|
||||
![image](https://user-images.githubusercontent.com/71636191/113112857-3fbd5d80-923c-11eb-9836-768325faf906.png)
|
||||
|
||||
![image](https://user-images.githubusercontent.com/71636191/135385039-38fdbd72-379a-422d-b97f-33df71fb1cec.png)
|
20
apps/rustdesk/data.yml
Normal file
@ -0,0 +1,20 @@
|
||||
name: RustDesk
|
||||
tags:
|
||||
- 工具
|
||||
title: RustDesk是一款开源的远程桌面软件
|
||||
type: 工具
|
||||
description: RustDesk是一款开源的远程桌面软件
|
||||
additionalProperties:
|
||||
key: rustdesk
|
||||
name: RustDesk
|
||||
tags:
|
||||
- Tool
|
||||
shortDescZh: RustDesk是一款开源的远程桌面软件
|
||||
shortDescEn: RustDesk is an open source remote desktop software
|
||||
type: tool
|
||||
crossVersionUpdate: false
|
||||
limit: 0
|
||||
recommend: 0
|
||||
website: https://rustdesk.com/zh/
|
||||
github: https://github.com/rustdesk/rustdesk
|
||||
document: https://rustdesk.com/docs/zh-cn/
|
50
apps/rustdesk/latest/data.yml
Normal file
@ -0,0 +1,50 @@
|
||||
additionalProperties:
|
||||
formFields:
|
||||
- default: 21115
|
||||
edit: true
|
||||
envKey: NAT_TEST_PORT
|
||||
labelEn: NAT type test port
|
||||
labelZh: NAT类型测试端口
|
||||
required: true
|
||||
rule: paramPort
|
||||
type: number
|
||||
- default: 21116
|
||||
edit: true
|
||||
envKey: HBBS_PORT
|
||||
labelEn: hbbs port (used with IP/domain)
|
||||
labelZh: hbbs端口(配合IP/域名使用)
|
||||
required: true
|
||||
rule: paramPort
|
||||
type: number
|
||||
- default: 21117
|
||||
edit: true
|
||||
envKey: HBBR_PORT
|
||||
labelEn: hbbr port (client relay server port)
|
||||
labelZh: hbbr端口(客户端中继服务器端口)
|
||||
required: true
|
||||
rule: paramPort
|
||||
type: number
|
||||
- default: 21118
|
||||
edit: true
|
||||
envKey: WEB_CLIENT_PORT1
|
||||
labelEn: Web Client Support Port 1
|
||||
labelZh: 网页客户端支持端口1
|
||||
required: true
|
||||
rule: paramPort
|
||||
type: number
|
||||
- default: 21119
|
||||
edit: true
|
||||
envKey: WEB_CLIENT_PORT2
|
||||
labelEn: Web Client Support Port 2
|
||||
labelZh: 网页客户端支持端口2
|
||||
required: true
|
||||
rule: paramPort
|
||||
type: number
|
||||
- default: 172.17.0.1
|
||||
edit: true
|
||||
envKey: HOST_ADDRESS
|
||||
labelEn: IP address or domain name (must change item)
|
||||
labelZh: IP地址或域名(必改项)
|
||||
required: true
|
||||
rule: paramCommon
|
||||
type: text
|
50
apps/rustdesk/latest/docker-compose.yml
Normal file
@ -0,0 +1,50 @@
|
||||
version: '3'
|
||||
services:
|
||||
hbbs:
|
||||
container_name: ${CONTAINER_NAME}_hbbs
|
||||
restart: always
|
||||
ports:
|
||||
- "${NAT_TEST_PORT}:21115" #NAT类型测试
|
||||
- "${HBBS_PORT}:21116" # 自定义 hbbs 映射端口
|
||||
- "${HBBS_PORT}:21116/udp" #自定义 hbbs 映射端口
|
||||
- "${WEB_CLIENT_PORT1}:21118" #网页客户端支持端口
|
||||
command: hbbs -r ${HOST_ADDRESS}:${HBBS_PORT} -k _ # 填入个人域名或 IP + 暴露端口
|
||||
volumes:
|
||||
- "./data/hbbs:/root" # 自定义挂载目录
|
||||
networks:
|
||||
- 1panel-network
|
||||
depends_on:
|
||||
- hbbr
|
||||
# deploy:
|
||||
# resources:
|
||||
# limits:
|
||||
# memory: 64M
|
||||
image: rustdesk/rustdesk-server:latest
|
||||
# image: rustdesk/rustdesk-server:latest-arm64v8 # 镜像选用 arm64 版
|
||||
labels:
|
||||
createdBy: "Apps"
|
||||
|
||||
hbbr:
|
||||
container_name: ${CONTAINER_NAME}_hbbr
|
||||
restart: always
|
||||
ports:
|
||||
- "${HBBR_PORT}:21117" # 自定义 hbbr 映射端口
|
||||
- "${WEB_CLIENT_PORT2}:21119" #网页客户端支持端口
|
||||
command: hbbr -k _
|
||||
volumes:
|
||||
- "./data/hbbr:/root" # 自定义挂载目录
|
||||
networks:
|
||||
- 1panel-network
|
||||
# deploy:
|
||||
# resources:
|
||||
# limits:
|
||||
# memory: 64M
|
||||
image: rustdesk/rustdesk-server:latest
|
||||
# image: rustdesk/rustdesk-server:latest-arm64v8 # 镜像选用 arm64 版
|
||||
labels:
|
||||
createdBy: "Apps"
|
||||
|
||||
networks:
|
||||
1panel-network:
|
||||
external: true
|
||||
|
BIN
apps/rustdesk/logo.png
Normal file
After Width: | Height: | Size: 11 KiB |
11
apps/synapse/1.86.0/data.yml
Normal file
@ -0,0 +1,11 @@
|
||||
additionalProperties:
|
||||
formFields:
|
||||
- default: 40026
|
||||
edit: true
|
||||
envKey: PANEL_APP_PORT_HTTP
|
||||
labelEn: Port
|
||||
labelZh: 端口
|
||||
required: true
|
||||
rule: paramPort
|
||||
type: number
|
||||
|
30
apps/synapse/1.86.0/docker-compose.yml
Normal file
@ -0,0 +1,30 @@
|
||||
version: "3"
|
||||
services:
|
||||
synapse:
|
||||
container_name: ${CONTAINER_NAME}
|
||||
restart: always
|
||||
networks:
|
||||
- 1panel-network
|
||||
volumes:
|
||||
- synapse-data:/data
|
||||
ports:
|
||||
- "${PANEL_APP_PORT_HTTP}:8008"
|
||||
environment:
|
||||
- TZ=Asia/Shanghai
|
||||
- UID=1000
|
||||
- GID=1000
|
||||
image: matrixdotorg/synapse:v1.86.0
|
||||
logging:
|
||||
options:
|
||||
max-size: "10m"
|
||||
command: run -m synapse.app.homeserver --config-path=/data/homeserver.yaml
|
||||
labels:
|
||||
createdBy: "Apps"
|
||||
|
||||
volumes:
|
||||
synapse-data:
|
||||
external: true
|
||||
|
||||
networks:
|
||||
1panel-network:
|
||||
external: true
|
244
apps/synapse/README.md
Normal file
@ -0,0 +1,244 @@
|
||||
# 使用说明
|
||||
|
||||
## 步骤1
|
||||
创建前需要使用终端运行以下命令创建依赖配置文件,
|
||||
需要按需修改参数`my.matrix.host`
|
||||
|
||||
|
||||
|
||||
```
|
||||
# 参数解释说明
|
||||
docker run -it --rm \
|
||||
-v synapse-data:/data \ # 挂载一个卷,将容器内的 /data 目录映射到 synapse-data 卷
|
||||
-e SYNAPSE_SERVER_NAME=my.matrix.host \ # 设置 Synapse 服务器的公共主机名
|
||||
-e SYNAPSE_REPORT_STATS=no \ # 禁用匿名统计报告
|
||||
-e SYNAPSE_HTTP_PORT=8008 \ # 设置 Synapse 监听的 HTTP 端口为 8008
|
||||
-e SYNAPSE_CONFIG_DIR=/data \ # 设置配置文件的存储位置为 /data
|
||||
-e SYNAPSE_DATA_DIR=/data \ # 设置持久数据的存储位置为 /data
|
||||
-e TZ=Asia/Shanghai \ # 设置容器的时区为亚洲/上海
|
||||
-e UID=1000 \ # 设置运行 Synapse 的用户 ID
|
||||
-e GID=1000 \ # 设置运行 Synapse 的用户组 ID
|
||||
matrixdotorg/synapse:latest generate # 运行最新版本的 matrixdotorg/synapse 镜像,并执行 generate 命令来生成配置文件
|
||||
|
||||
```
|
||||
实际运行命令,注意修改
|
||||
```
|
||||
docker run -it --rm \
|
||||
-v synapse-data:/data \
|
||||
-e SYNAPSE_SERVER_NAME=my.matrix.host \
|
||||
-e SYNAPSE_REPORT_STATS=no \
|
||||
-e SYNAPSE_HTTP_PORT=8008 \
|
||||
-e SYNAPSE_CONFIG_DIR=/data \
|
||||
-e SYNAPSE_DATA_DIR=/data \
|
||||
-e TZ=Asia/Shanghai \
|
||||
-e UID=1000 \
|
||||
-e GID=1000 \
|
||||
matrixdotorg/synapse:latest generate
|
||||
|
||||
```
|
||||
|
||||
配置文件默认存放路径是在一个`synapse-data`存储卷里,
|
||||
```
|
||||
# 配置文件路径
|
||||
/var/lib/docker/volumes/synapse-data/_data
|
||||
```
|
||||
|
||||
## 步骤2
|
||||
创建应用
|
||||
|
||||
## 步骤3
|
||||
|
||||
需要打开容器,运行命令创建用户
|
||||
|
||||
```
|
||||
# 创建管理员账户
|
||||
# register_new_matrix_user http://localhost:8008 -c /data/homeserver.yaml -a -u 用户名 -p 密码
|
||||
register_new_matrix_user http://localhost:8008 -c /data/homeserver.yaml -a -u admin -p password
|
||||
|
||||
# 创建普通用户账户
|
||||
# register_new_matrix_user http://localhost:8008 -c /data/homeserver.yaml --no-admin -u 用户名 -p 密码
|
||||
register_new_matrix_user http://localhost:8008 -c /data/homeserver.yaml --no-admin -u user -p password
|
||||
|
||||
# 查看更多命令与帮助
|
||||
register_new_matrix_user http://localhost:8008 -c /data/homeserver.yaml --help
|
||||
```
|
||||
|
||||
`register_new_matrix_user`自带命令
|
||||
|
||||
```
|
||||
usage: register_new_matrix_user [-h] [-u USER] [-p PASSWORD] [-t USER_TYPE] [-a | --no-admin] (-c CONFIG | -k SHARED_SECRET) [server_url]
|
||||
用法:register_new_matrix_user [-h] [-u USER] [-p PASSWORD] [-t USER_TYPE] [-a | --no-admin] (-c CONFIG | -k SHARED_SECRET) [server_url]
|
||||
|
||||
Used to register new users with a given homeserver when registration has been disabled. The homeserver must be configured with the 'registration_shared_secret' option set.
|
||||
用于在注册被禁用时,通过给定的homeserver注册新用户。homeserver必须配置'registration_shared_secret'选项。
|
||||
|
||||
positional arguments:
|
||||
位置参数:
|
||||
server_url URL to use to talk to the homeserver. By default, tries to find a suitable URL from the configuration file. Otherwise, defaults to 'http://localhost:8008'.
|
||||
server_url 与homeserver通信的URL。默认情况下,尝试从配置文件中找到合适的URL。否则,默认为'http://localhost:8008'。
|
||||
|
||||
options:
|
||||
选项:
|
||||
-h, --help show this help message and exit
|
||||
-h, --help 显示帮助信息并退出
|
||||
-u USER, --user USER Local part of the new user. Will prompt if omitted.
|
||||
-u USER, --user USER 新用户的本地部分。如果省略,将提示输入。
|
||||
-p PASSWORD, --password PASSWORD
|
||||
New password for user. Will prompt if omitted.
|
||||
-p PASSWORD, --password PASSWORD
|
||||
用户的新密码。如果省略,将提示输入。
|
||||
-t USER_TYPE, --user_type USER_TYPE
|
||||
User type as specified in synapse.api.constants.UserTypes
|
||||
-t USER_TYPE, --user_type USER_TYPE
|
||||
用户类型,如synapse.api.constants.UserTypes中所指定的
|
||||
-a, --admin Register new user as an admin. Will prompt if --no-admin is not set either.
|
||||
-a, --admin 将新用户注册为管理员。如果未设置--no-admin,也会提示输入。
|
||||
--no-admin Register new user as a regular user. Will prompt if --admin is not set either.
|
||||
--no-admin 将新用户注册为普通用户。如果未设置--admin,也会提示输入。
|
||||
-c CONFIG, --config CONFIG
|
||||
Path to server config file. Used to read in shared secret.
|
||||
-c CONFIG, --config CONFIG
|
||||
服务器配置文件的路径。用于读取共享密钥。
|
||||
-k SHARED_SECRET, --shared-secret SHARED_SECRET
|
||||
Shared secret as defined in server config file.
|
||||
-k SHARED_SECRET, --shared-secret SHARED_SECRET
|
||||
服务器配置文件中定义的共享密钥。
|
||||
```
|
||||
|
||||
## 提示
|
||||
|
||||
所有数据存放在`synapse-data`存储卷里,
|
||||
|
||||
删除应用时,假如需要完全清除数据,还需要将`synapse-data`存储卷删除。
|
||||
|
||||
# 原始相关
|
||||
## Synapse
|
||||
[![(get support on #synapse:matrix.org)](https://img.shields.io/matrix/synapse:matrix.org?label=support&logo=matrix)](https://matrix.to/#/#synapse:matrix.org) [![(discuss development on #synapse-dev:matrix.org)](https://img.shields.io/matrix/synapse-dev:matrix.org?label=development&logo=matrix)](https://matrix.to/#/#synapse-dev:matrix.org) [![(Rendered documentation on GitHub Pages)](https://img.shields.io/badge/documentation-%E2%9C%93-success)](https://matrix-org.github.io/synapse/latest/) [![(check license in LICENSE file)](https://img.shields.io/github/license/matrix-org/synapse)](https://raw.githubusercontent.com/matrix-org/synapse/develop/LICENSE) [![(latest version released on PyPi)](https://img.shields.io/pypi/v/matrix-synapse)](https://pypi.org/project/matrix-synapse) [![(supported python versions)](https://img.shields.io/pypi/pyversions/matrix-synapse)](https://pypi.org/project/matrix-synapse)
|
||||
|
||||
Synapse is an open-source [Matrix](https://matrix.org/) homeserver written and maintained by the [Matrix.org](https://github.com/matrix-org/Matrix.org) Foundation. We began rapid development in 2014, reaching v1.0.0 in 2019. Development on Synapse and the Matrix protocol itself continues in earnest today.
|
||||
|
||||
Briefly, Matrix is an open standard for communications on the internet, supporting federation, encryption and VoIP. [Matrix.org](https://github.com/matrix-org/Matrix.org) has more to say about the [goals of the Matrix project](https://matrix.org/docs/guides/introduction), and the [formal specification](https://spec.matrix.org/) describes the technical details.
|
||||
|
||||
Contents
|
||||
|
||||
- <a id="user-content-id1"></a>[Installing and configuration](#installing-and-configuration)
|
||||
- <a id="user-content-id2"></a>[Using a reverse proxy with Synapse](#using-a-reverse-proxy-with-synapse)
|
||||
- <a id="user-content-id3"></a>[Upgrading an existing Synapse](#upgrading-an-existing-synapse)
|
||||
- <a id="user-content-id4"></a>[Platform dependencies](#platform-dependencies)
|
||||
- <a id="user-content-id5"></a>[Security note](#security-note)
|
||||
- <a id="user-content-id6"></a>[Testing a new installation](#testing-a-new-installation)
|
||||
- <a id="user-content-id7"></a>[Registering a new user from a client](#registering-a-new-user-from-a-client)
|
||||
- <a id="user-content-id8"></a>[Troubleshooting and support](#troubleshooting-and-support)
|
||||
- <a id="user-content-id9"></a>[Identity Servers](#identity-servers)
|
||||
- <a id="user-content-id10"></a>[Development](#development)
|
||||
|
||||
<a id="user-content-installing-and-configuration"></a>
|
||||
|
||||
## [Installing and configuration](#id1)
|
||||
|
||||
The Synapse documentation describes [how to install Synapse](https://matrix-org.github.io/synapse/latest/setup/installation.html). We recommend using [Docker images](https://matrix-org.github.io/synapse/latest/setup/installation.html#docker-images-and-ansible-playbooks) or [Debian packages from Matrix.org](https://matrix-org.github.io/synapse/latest/setup/installation.html#matrixorg-packages).
|
||||
|
||||
Synapse has a variety of [config options](https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html) which can be used to customise its behaviour after installation. There are additional details on how to [configure Synapse for federation here](https://matrix-org.github.io/synapse/latest/federate.html).
|
||||
|
||||
<a id="user-content-using-a-reverse-proxy-with-synapse"></a>
|
||||
|
||||
### [Using a reverse proxy with Synapse](#id2)
|
||||
|
||||
It is recommended to put a reverse proxy such as [nginx](https://nginx.org/en/docs/http/ngx_http_proxy_module.html), [Apache](https://httpd.apache.org/docs/current/mod/mod_proxy_http.html), [Caddy](https://caddyserver.com/docs/quick-starts/reverse-proxy), [HAProxy](https://www.haproxy.org/) or [relayd](https://man.openbsd.org/relayd.8) in front of Synapse. One advantage of doing so is that it means that you can expose the default https port (443) to Matrix clients without needing to run Synapse with root privileges. For information on configuring one, see [the reverse proxy docs](https://matrix-org.github.io/synapse/latest/reverse_proxy.html).
|
||||
|
||||
<a id="user-content-upgrading-an-existing-synapse"></a>
|
||||
|
||||
### [Upgrading an existing Synapse](#id3)
|
||||
|
||||
The instructions for upgrading Synapse are in [the upgrade notes](https://matrix-org.github.io/synapse/develop/upgrade.html). Please check these instructions as upgrading may require extra steps for some versions of Synapse.
|
||||
|
||||
<a id="user-content-platform-dependencies"></a>
|
||||
|
||||
### [Platform dependencies](#id4)
|
||||
|
||||
Synapse uses a number of platform dependencies such as Python and PostgreSQL, and aims to follow supported upstream versions. See the [deprecation policy](https://matrix-org.github.io/synapse/latest/deprecation_policy.html) for more details.
|
||||
|
||||
<a id="user-content-security-note"></a>
|
||||
|
||||
### [Security note](#id5)
|
||||
|
||||
Matrix serves raw, user-supplied data in some APIs -- specifically the [content repository endpoints](https://matrix.org/docs/spec/client_server/latest.html#get-matrix-media-r0-download-servername-mediaid).
|
||||
|
||||
Whilst we make a reasonable effort to mitigate against XSS attacks (for instance, by using [CSP](https://github.com/matrix-org/synapse/pull/1021)), a Matrix homeserver should not be hosted on a domain hosting other web applications. This especially applies to sharing the domain with Matrix web clients and other sensitive applications like webmail. See https://developer.github.com/changes/2014-04-25-user-content-security for more information.
|
||||
|
||||
Ideally, the homeserver should not simply be on a different subdomain, but on a completely different [registered domain](https://tools.ietf.org/html/draft-ietf-httpbis-rfc6265bis-03#section-2.3) (also known as top-level site or eTLD+1). This is because [some attacks](https://en.wikipedia.org/wiki/Session_fixation#Attacks_using_cross-subdomain_cookie) are still possible as long as the two applications share the same registered domain.
|
||||
|
||||
To illustrate this with an example, if your Element Web or other sensitive web application is hosted on `A.example1.com`, you should ideally host Synapse on `example2.com`. Some amount of protection is offered by hosting on `B.example1.com` instead, so this is also acceptable in some scenarios. However, you should *not* host your Synapse on `A.example1.com`.
|
||||
|
||||
Note that all of the above refers exclusively to the domain used in Synapse's `public_baseurl` setting. In particular, it has no bearing on the domain mentioned in MXIDs hosted on that server.
|
||||
|
||||
Following this advice ensures that even if an XSS is found in Synapse, the impact to other applications will be minimal.
|
||||
|
||||
<a id="user-content-testing-a-new-installation"></a>
|
||||
|
||||
## [Testing a new installation](#id6)
|
||||
|
||||
The easiest way to try out your new Synapse installation is by connecting to it from a web client.
|
||||
|
||||
Unless you are running a test instance of Synapse on your local machine, in general, you will need to enable TLS support before you can successfully connect from a client: see [TLS certificates](https://matrix-org.github.io/synapse/latest/setup/installation.html#tls-certificates).
|
||||
|
||||
An easy way to get started is to login or register via Element at https://app.element.io/#/login or https://app.element.io/#/register respectively. You will need to change the server you are logging into from `matrix.org` and instead specify a Homeserver URL of `https://<server_name>:8448` (or just `https://<server_name>` if you are using a reverse proxy). If you prefer to use another client, refer to our [client breakdown](https://matrix.org/docs/projects/clients-matrix).
|
||||
|
||||
If all goes well you should at least be able to log in, create a room, and start sending messages.
|
||||
|
||||
<a id="user-content-registering-a-new-user-from-a-client"></a>
|
||||
|
||||
### [Registering a new user from a client](#id7)
|
||||
|
||||
By default, registration of new users via Matrix clients is disabled. To enable it:
|
||||
|
||||
1. In the [registration config section](https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html#registration) set `enable_registration: true` in `homeserver.yaml`.
|
||||
2. Then **either**:
|
||||
1. set up a [CAPTCHA](https://matrix-org.github.io/synapse/latest/CAPTCHA_SETUP.html), or
|
||||
2. set `enable_registration_without_verification: true` in `homeserver.yaml`.
|
||||
|
||||
We **strongly** recommend using a CAPTCHA, particularly if your homeserver is exposed to the public internet. Without it, anyone can freely register accounts on your homeserver. This can be exploited by attackers to create spambots targetting the rest of the Matrix federation.
|
||||
|
||||
Your new user name will be formed partly from the `server_name`, and partly from a localpart you specify when you create the account. Your name will take the form of:
|
||||
|
||||
@localpart:my.domain.name
|
||||
|
||||
(pronounced "at localpart on my dot domain dot name").
|
||||
|
||||
As when logging in, you will need to specify a "Custom server". Specify your desired `localpart` in the 'User name' box.
|
||||
|
||||
<a id="user-content-troubleshooting-and-support"></a>
|
||||
|
||||
## [Troubleshooting and support](#id8)
|
||||
|
||||
The [Admin FAQ](https://matrix-org.github.io/synapse/latest/usage/administration/admin_faq.html) includes tips on dealing with some common problems. For more details, see [Synapse's wider documentation](https://matrix-org.github.io/synapse/latest/).
|
||||
|
||||
For additional support installing or managing Synapse, please ask in the community support room [`#synapse:matrix.org`](https://matrix.to/#/#synapse:matrix.org) (from a [matrix.org](https://github.com/matrix-org/matrix.org) account if necessary). We do not use GitHub issues for support requests, only for bug reports and feature requests.
|
||||
|
||||
<a id="user-content-identity-servers"></a>
|
||||
|
||||
## [Identity Servers](#id9)
|
||||
|
||||
Identity servers have the job of mapping email addresses and other 3rd Party IDs (3PIDs) to Matrix user IDs, as well as verifying the ownership of 3PIDs before creating that mapping.
|
||||
|
||||
**They are not where accounts or credentials are stored - these live on home servers. Identity Servers are just for mapping 3rd party IDs to matrix IDs.**
|
||||
|
||||
This process is very security-sensitive, as there is obvious risk of spam if it is too easy to sign up for Matrix accounts or harvest 3PID data. In the longer term, we hope to create a decentralised system to manage it ([matrix-doc #712](https://github.com/matrix-org/matrix-doc/issues/712)), but in the meantime, the role of managing trusted identity in the Matrix ecosystem is farmed out to a cluster of known trusted ecosystem partners, who run 'Matrix Identity Servers' such as [Sydent](https://github.com/matrix-org/sydent), whose role is purely to authenticate and track 3PID logins and publish end-user public keys.
|
||||
|
||||
You can host your own copy of Sydent, but this will prevent you reaching other users in the Matrix ecosystem via their email address, and prevent them finding you. We therefore recommend that you use one of the centralised identity servers at `https://matrix.org` or `https://vector.im` for now.
|
||||
|
||||
To reiterate: the Identity server will only be used if you choose to associate an email address with your account, or send an invite to another user via their email address.
|
||||
|
||||
<a id="user-content-development"></a>
|
||||
|
||||
## [Development](#id10)
|
||||
|
||||
We welcome contributions to Synapse from the community! The best place to get started is our [guide for contributors](https://matrix-org.github.io/synapse/latest/development/contributing_guide.html). This is part of our larger [documentation](https://matrix-org.github.io/synapse/latest), which includes
|
||||
|
||||
information for Synapse developers as well as Synapse administrators. Developers might be particularly interested in:
|
||||
|
||||
- [Synapse's database schema](https://matrix-org.github.io/synapse/latest/development/database_schema.html),
|
||||
- [notes on Synapse's implementation details](https://matrix-org.github.io/synapse/latest/development/internal_documentation/index.html), and
|
||||
- [how we use git](https://matrix-org.github.io/synapse/latest/development/git.html).
|
||||
|
||||
Alongside all that, join our developer community on Matrix: [#synapse-dev:matrix.org](https://matrix.to/#/#synapse-dev:matrix.org), featuring real humans!
|
20
apps/synapse/data.yml
Normal file
@ -0,0 +1,20 @@
|
||||
name: Synapse
|
||||
tags:
|
||||
- 工具
|
||||
title: Synapse是一个开源的Matrix家庭服务器,自建聊天服务端
|
||||
type: 工具
|
||||
description: Synapse是一个开源的Matrix家庭服务器,自建聊天服务端
|
||||
additionalProperties:
|
||||
key: synapse
|
||||
name: Synapse
|
||||
tags:
|
||||
- Tool
|
||||
shortDescZh: Synapse是一个开源的Matrix家庭服务器,自建聊天服务端
|
||||
shortDescEn: Synapse is an open-source Matrix homeserver,build your own chat server
|
||||
type: tool
|
||||
crossVersionUpdate: true
|
||||
limit: 1
|
||||
recommend: 0
|
||||
website: https://matrix.org/docs/projects/server/synapse
|
||||
github: https://github.com/matrix-org/synapse
|
||||
document: https://matrix-org.github.io/synapse/latest/
|
BIN
apps/synapse/logo.png
Normal file
After Width: | Height: | Size: 2.9 KiB |