jriou/coller
1
0
Fork 0
Code Issues 5 Pull requests Releases 1 Activity Actions

docs: Add READMEs

Browse source 
Signed-off-by: Julien Riou <julien@riou.xyz>
This commit is contained in:
Julien Riou 2025-08-24 15:48:12 +02:00
parent e22105049a
commit 7c00b364d1
Signed by: jriou
GPG key ID: 9A099EDA51316854
5 changed files with 143 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

31
src/cmd/collerd/README.md Normal file
View file

@ -0,0 +1,31 @@
# collerd
Server to manage notes:
* Website
* API
* Database management
## Usage
```
collerd -help
```
## Configuration
The file format is **JSON**:
* **title** (string): Title of the website
* **database_type** (string): Type of the database (default "sqlite", "postgres" also supported)
* **database_dsn** (string): Connection string for the database (default "collerd.db")
* **id_length** (int): Number of characters for note identifiers (default 5)
* **password_length** (int): Number of characters for generated passwords (default 16)
* **expiration_interval** (int): Number of seconds to wait between two expiration runs
* **listen_address** (string): Address to listen for the web server (default "127.0.0.1")
* **listen_port** (int): Port to listen for the web server (default 8080)
* **expirations** ([]int): List of supported expiration times in seconds (default 300, 86400, 604800, 18144000)
* **expiration** (int): Default expiration time in seconds
* **max_upload_size** (int): Maximum number of bytes received by the server for notes (the base64 encoding may use more space than the real size of the note)
* **show_version** (bool): Show version on the website
The configuration file is not required but the service might not be exposed to the public.