Merge pull request 'Update INSTALL.MD to clarify that RECAPCHA_* isn't necessary' (#140) from somoso/pyfedi:update-install-md into main

Reviewed-on: https://codeberg.org/rimu/pyfedi/pulls/140
This commit is contained in:
rimu 2024-04-01 21:42:34 +00:00
commit f405e4d0c7

View file

@ -110,12 +110,11 @@ pip install -r requirements.txt
DATABASE_URL=postgresql+psycopg2://username:password@localhost/database_name DATABASE_URL=postgresql+psycopg2://username:password@localhost/database_name
``` ```
* Also change `SECRET_KEY` to some random sequence of numbers and letters. * Also change `SECRET_KEY` to some random sequence of numbers and letters.
* `RECAPTCHA_PUBLIC_KEY` and `RECAPTCHA_PRIVATE_KEY` can be generated at https://www.google.com/recaptcha/admin/create.
### Extra info ### Extra info
* `SERVER_NAME` should be the domain of the site/instance. Use `127.0.0.1:5000` during development unless using ngrok. * `SERVER_NAME` should be the domain of the site/instance. Use `127.0.0.1:5000` during development unless using ngrok.
* `RECAPTCHA_PUBLIC_KEY` and `RECAPTCHA_PRIVATE_KEY` can be generated at https://www.google.com/recaptcha/admin/create (this is optional - omit to allow registration without RECAPCHA).
* `CACHE_TYPE` can be `FileSystemCache` or `RedisCache`. `FileSystemCache` is fine during development (set `CACHE_DIR` to `/tmp/piefed` or `/dev/shm/piefed`) * `CACHE_TYPE` can be `FileSystemCache` or `RedisCache`. `FileSystemCache` is fine during development (set `CACHE_DIR` to `/tmp/piefed` or `/dev/shm/piefed`)
while `RedisCache` **should** be used in production. If using `RedisCache`, set `CACHE_REDIS_URL` to `redis://localhost:6379/1` while `RedisCache` **should** be used in production. If using `RedisCache`, set `CACHE_REDIS_URL` to `redis://localhost:6379/1`