Notes/README.md

41 lines
611 B
Markdown
Raw Permalink Normal View History

2023-12-28 08:13:21 +01:00
# Run from scratch
## Database
Create an empty database. The configured user needs to be able to create and alter stuff.
## Configuration
2023-12-28 07:47:23 +01:00
Create a configuration file `$HOME/.config/notes.yaml` with the following content:
```yaml
2024-04-19 15:34:30 +02:00
network:
address: '[::]'
port: 1371
2023-12-28 07:47:23 +01:00
websocket:
domains:
- notes.com
database:
host: 127.0.0.1
port: 5432
name: notes.com
username: notes
password: SomePassword
application:
directories:
static: /usr/local/share/notes
upload: /usr/local/lib/notes/upload
session:
daysvalid: 31
```
2023-12-28 08:13:21 +01:00
## User
Create a user by running
```
notes --createuser
```