WIP: External access

This commit is contained in:
purple_emily
2024-03-10 13:15:05 +00:00
parent 5584143eeb
commit 64149c55a8
2 changed files with 23 additions and 12 deletions

View File

@@ -17,17 +17,30 @@ To enable external access for Knight Crawler, whether it's within your home netw
need to follow these initial setup steps: need to follow these initial setup steps:
- Set up Caddy, a powerful and easy-to-use web server. - Set up Caddy, a powerful and easy-to-use web server.
1. Caddy is included in the <path>deployment/docker/optional</path>
2.
- Disable the open port in the Knight Crawler <path>docker-compose.yaml<path> file. - Disable the open port in the Knight Crawler <path>docker-compose.yaml<path> file.
1. Open the Knight Crawler <path>docker-compose.yaml<path> file in your favourite editor.
2. Disable the default port configuration. This step is crucial for routing external traffic through Caddy and ensuring secure access to Knight Crawler. Simply comment out or remove the port configuration section within the Docker-Compose file.
yaml
# ports: ### Caddy
# - "8080:8080"
A basic Caddy configuration is included with Knight Crawler in the deployment directory.
<path>deployment/docker/optional-services/caddy</path>
```Generic
deployment/
└── docker/
└── optional-services/
└── caddy/
├── config/
│ ├── snippets/
│ │ └── cloudflare-replace-X-Forwarded-For
│ └── Caddyfile
├── logs/
└── docker-compose.yaml
```
ports:
- "8080:8080"
By disabling the default port, Knight Crawler will only be accessible internally within your network, ensuring added security. By disabling the default port, Knight Crawler will only be accessible internally within your network, ensuring added security.

View File

@@ -108,10 +108,8 @@ then try increasing it by 10 at a time.
> >
{style="warning"} {style="warning"}
`CONSUMER_REPLICAS` is how many consumers should be initially started. This is best kept below 10 as GitHub rate limit `CONSUMER_REPLICAS` is how many consumers should be initially started. You can increase or decrease the number of consumers whilst the
how fast we can access a list of torrent trackers. You can increase or decrease the number of consumers whilst the service is running by running the command `docker compose up -d --scale consumer=<number>`.
service is running by running the command `docker compose up -d --scale consumer=<number>`. This value is best increased by 5 at a time.
Repeat this process until you have reached the desired level of consumers.
### GitHub personal access token ### GitHub personal access token