From 64149c55a88ed3db311b8445bd85b5f6f751490d Mon Sep 17 00:00:00 2001 From: purple_emily Date: Sun, 10 Mar 2024 13:15:05 +0000 Subject: [PATCH] WIP: External access --- docs/Writerside/topics/External-access.md | 29 ++++++++++++++++------- docs/Writerside/topics/Getting-started.md | 6 ++--- 2 files changed, 23 insertions(+), 12 deletions(-) diff --git a/docs/Writerside/topics/External-access.md b/docs/Writerside/topics/External-access.md index a57e635..3d42e1d 100644 --- a/docs/Writerside/topics/External-access.md +++ b/docs/Writerside/topics/External-access.md @@ -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: - Set up Caddy, a powerful and easy-to-use web server. - 1. Caddy is included in the deployment/docker/optional - 2. - - Disable the open port in the Knight Crawler docker-compose.yaml file. - 1. Open the Knight Crawler docker-compose.yaml 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: -# - "8080:8080" +### Caddy + +A basic Caddy configuration is included with Knight Crawler in the deployment directory. + +deployment/docker/optional-services/caddy + +```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. diff --git a/docs/Writerside/topics/Getting-started.md b/docs/Writerside/topics/Getting-started.md index 0d93281..fdafdf0 100644 --- a/docs/Writerside/topics/Getting-started.md +++ b/docs/Writerside/topics/Getting-started.md @@ -108,10 +108,8 @@ then try increasing it by 10 at a time. > {style="warning"} -`CONSUMER_REPLICAS` is how many consumers should be initially started. This is best kept below 10 as GitHub rate limit -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=`. This value is best increased by 5 at a time. -Repeat this process until you have reached the desired level of consumers. +`CONSUMER_REPLICAS` is how many consumers should be initially started. You can increase or decrease the number of consumers whilst the +service is running by running the command `docker compose up -d --scale consumer=`. ### GitHub personal access token