yagich/pyrom
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

touch up the instructions and config example

Browse Source
This commit is contained in:
Lera Elvoé
2025-12-20 17:08:04 +03:00
parent a93a89f0df
commit a808137e5b
2 changed files with 36 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@@ -9,10 +9,19 @@ Please read the [full terms](./LICENSE.md) for proper wording.
# installing & first time setup # installing & first time setup
## docker (production) ## docker (production)
create `config/secrets.prod.env` according to `config/secrets.prod.env.example` 1. clone the repo
2. create `config/secrets.prod.env` according to `config/secrets.prod.env.example`
3. create `config/pyrom_config.toml` according to `config/pyrom_config.toml.example` and modify as needed
4. make sure the `data/` folder is writable by the app:
```bash ```bash
$ docker compose up $ chmod -R 777 data/
```
5. bring up the container:
```bash
$ docker compose up --build
``` ```
- opens port 8080 - opens port 8080
@@ -20,10 +29,10 @@ $ docker compose up
make sure to run it in an interactive session the first time, because it will spit out the password to the auto-created admin account. make sure to run it in an interactive session the first time, because it will spit out the password to the auto-created admin account.
alternatively, if you already had porom running before, put the db file (`db.prod.sqlite`) in `data/db` and it will Just Work. 6. point your favorite proxy at `localhost:8080`
## manual (development) ## manual (development)
1. install python >= 3.11, sqlite3, libargon2, and imagemagick & clone repo 1. install python >= 3.13, sqlite3, libargon2, and imagemagick & clone repo
2. create a venv: 2. create a venv:
```bash ```bash

26
config/pyrom_config.toml.example
View File

@@ -1,11 +1,31 @@
### REQUIRED CONFIGURATION
## the following settings are required.
## the app will not work if they are missing.
# the domain name you will be serving Pyrom from, without the scheme, including the subdomain(s).
# this is overridden by the app in development.
# used for generating URLs.
# the app will not start if this field is missing.
SERVER_NAME = "forum.your.domain"
### OPTIONAL CONFIGURATION
## the following settings are set to their default values.
## you can override any of them.
# your forum's name, shown on the header.
SITE_NAME = "Pyrom" SITE_NAME = "Pyrom"
DISABLE_SIGNUP = false # if true, no one can sign up.
# if true, users can not sign up manually. see the following two settings.
DISABLE_SIGNUP = false
# if neither of the following two options is true, # if neither of the following two options is true,
# no one can sign up. this may be useful later when/if LDAP is implemented. # no one can sign up. this may be useful later when/if LDAP is implemented.
MODS_CAN_INVITE = true # if true, allows moderators to create invite links. useless unless DISABLE_SIGNUP to be true. # if true, allows moderators to create invite links. useless unless DISABLE_SIGNUP is true.
USERS_CAN_INVITE = false # if true, allows users to create invite links. useless unless DISABLE_SIGNUP to be true. MODS_CAN_INVITE = true
# if true, allows users to create invite links. useless unless DISABLE_SIGNUP is true.
USERS_CAN_INVITE = false
# contact information, will be shown in /guides/contact # contact information, will be shown in /guides/contact
# some babycodes allowed # some babycodes allowed