From d01b4b6a1a76db4ecfbe68dd230d72cc13df88c9 Mon Sep 17 00:00:00 2001 From: Alan Roberts Date: Fri, 9 Aug 2024 18:30:02 -0400 Subject: [PATCH] adding dev mode documentation to install.md --- INSTALL.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/INSTALL.md b/INSTALL.md index 4ae70c7b..7e056aaa 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -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 `/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_". +
## Initialise database, and set up admin account