Canithesis/checkpoint
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add nginx info

Browse Source 
ref #18
This commit is contained in:
Vaxry
2025-04-20 16:37:47 +01:00
parent 06007e2a36
commit 1c8625ffa4
2 changed files with 10 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@@ -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. 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`. 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. 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).

6
docs/FAQ.md Normal file
View File

@@ -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.