From 1c8625ffa4e7827ed46d6b91894555cd90a5faf1 Mon Sep 17 00:00:00 2001 From: Vaxry Date: Sun, 20 Apr 2025 16:37:47 +0100 Subject: [PATCH] docs: add nginx info ref #18 --- README.md | 4 ++++ docs/FAQ.md | 6 ++++++ 2 files changed, 10 insertions(+) create mode 100644 docs/FAQ.md diff --git a/README.md b/README.md index b1d7516..ca122c1 100644 --- a/README.md +++ b/README.md @@ -31,3 +31,7 @@ If you are using this, it's almost certain search engines will stop indexing you 3. Adjust the config to your needs. Options are documented with comments in the example config. 4. Set up your IP rules if you want. These allow you to set up IPs that are automatically blocked, or allowed to access without a challenge. This is useful for e.g. search engine scrapers. Some IP ranges can be found in `example/index_bots.jsonc`. 5. Run checkpoint with your config: `./build/checkpoint -c config.jsonc`. How you run it long-term as a service is up to you. + +## FAQ / Setup info + +See [docs/FAQ](./docs/FAQ.md). \ No newline at end of file diff --git a/docs/FAQ.md b/docs/FAQ.md new file mode 100644 index 0000000..408ef45 --- /dev/null +++ b/docs/FAQ.md @@ -0,0 +1,6 @@ +## FAQ / Setup info + +### Nginx / proxy + +In order for checkpoint to understand nginx / another reverse proxy you run on your server, make sure +it passes the `Host` header properly to checkpoint. \ No newline at end of file