michael/pyfedi
1
0
Fork 0
mirror of https://codeberg.org/rimu/pyfedi synced 2025-01-23 19:36:56 -08:00
Code Issues Projects Releases Packages Wiki Activity Actions

adding dev mode documentation to install.md

Browse source
This commit is contained in:
Alan Roberts 2024-08-09 18:30:02 -04:00
parent d0ffaccd58
commit d01b4b6a1a
1 changed files with 7 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
INSTALL.md
View file

@ -113,6 +113,7 @@ pip install -r requirements.txt
### Extra info
* `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`)
@ -139,6 +140,12 @@ If it does not work check the log file at logs/pyfedi.log for clues.
will be treated as bounces and deleted after extracting the email addresses in them. Use a dedicated inbox
for bounces, not a inbox you also use for other purposes.
### Development mode
Setting `MODE=development` in the `.env` file will enable the `<your-site>/dev/tools` page.
That page can be accessed from the `Admin` navigation drop down, or nav bar as `Dev Tools`. That page has buttons that can create/delete communities and topics. The communities and topics will all begin with "dev_".
<div id="initialise-database-and-setup-admin-account"></div>
## Initialise database, and set up admin account