brass/README.md

49 lines
962 B
Markdown

# Getting started with developing
1. Clone the repository.
2. Install and configure Postgresql. Create a new database for brass: `createdb brass`.
3. TODO: Configure DB name, DB user & pass, DB connection string, ...
4. Install sqlx-cli: `cargo install sqlx-cli`
5. Migrate the database: `sqlx database setup`
6. Create superuse: `cargo r -- createadmin`
## Useful stuff
- cargo-watch, cargo-add
- mailtutan
## Example Deployment OpenBSD
```
#!/bin/ksh
daemon="/usr/local/bin/brass"
daemon_execdir="/etc/brass"
daemon_user="www"
daemon_logger="daemon.info"
. /etc/rc.d/rc.subr
#pexp="$daemon"
rc_bg=YES
rc_reload=NO
```
```
# Postgres
# DATABASE_URL=postgres://postgres@localhost/my_database
# SQLite
DATABASE_URL=postgresql://brass:password@localhost/brass
# 64 byte long
SECRET_KEY="secret key"
HOSTNAME="brass.tfld.de"
ADDRESS="127.0.0.1"
PORT="8081"
SMTP_SERVER="localhost"
SMTP_PORT="25"
# SMTP_LOGIN=""
# SMTP_PASSWORD=""
SMTP_TLSTYPE="none"
```