mirror of
https://github.com/spacedeck/spacedeck-open.git
synced 2025-12-15 17:37:30 +01:00
Merge branch 'mnt' into config/disable-db-logs
This commit is contained in:
60
README.md
60
README.md
@@ -45,10 +45,50 @@ To install all node dependencies, run (do this once):
|
||||
|
||||
See [config/default.json](config/default.json). Set `storage_local_path` for a local sqlite database or `storage_region`, `storage_bucket`, `storage_cdn` and `storage_endpoint` for AWS S3. `mail_provider` may be one of `console` or `smtp`. Also, omit a trailing `/` for the `endpoint`.
|
||||
|
||||
|
||||
## Disable DB logs
|
||||
|
||||
```json
|
||||
...
|
||||
"db_logs_disabled": true
|
||||
...
|
||||
```
|
||||
|
||||
## Configure color swatches
|
||||
|
||||
Add a custom array of swatches to your config/default.json.
|
||||
|
||||
**You should include the swatch transparent (rgba(0,0,0,0)) so users can remove the color applied.**
|
||||
|
||||
## Configure default colors
|
||||
You can define text, stroke and fill color in your config/default.json.
|
||||
|
||||
**You also should include the default colors in your custom swatches palette.**
|
||||
|
||||
```json
|
||||
...
|
||||
"spacedeck": {
|
||||
"default_text_color": "#E11F26",
|
||||
"default_stroke_color": "#9E0F13",
|
||||
"default_fill_color": "#64BCCA",
|
||||
"swatches": [
|
||||
{"id":8, "hex":"#000000"},
|
||||
{"id":30, "hex":"rgba(0,0,0,0)"},
|
||||
{"id":31, "hex": "#E11F26"},
|
||||
{"id":32, "hex": "#9E0F13"},
|
||||
{"id":33, "hex": "#64BCCA"},
|
||||
{"id":34, "hex": "#40808A"},
|
||||
{"id":35, "hex": "#036492"},
|
||||
{"id":36, "hex": "#005179"},
|
||||
{"id":37, "hex": "#84427E"},
|
||||
{"id":38, "hex": "#6C3468"},
|
||||
{"id":39, "hex": "#F79B84"},
|
||||
{"id":40, "hex": "#B57362"},
|
||||
{"id":41, "hex": "#E7D45A"},
|
||||
{"id":42, "hex": "#ACA044"}
|
||||
]
|
||||
}
|
||||
...
|
||||
```
|
||||
|
||||
# Run (web server)
|
||||
@@ -70,6 +110,26 @@ For advanced media conversion:
|
||||
By default, media files are uploaded to the ```storage``` folder.
|
||||
The database is stored in ```database.sqlite``` by default.
|
||||
|
||||
# Other databases (Not officially supported)
|
||||
|
||||
## Postgres
|
||||
|
||||
Add the [pg](https://www.npmjs.com/package/pg) module and change the config/default.json to
|
||||
|
||||
```
|
||||
"storage_dialect": "postgres",
|
||||
```
|
||||
|
||||
Adapt the other values as needed
|
||||
|
||||
```
|
||||
"storage_host": "localhost",
|
||||
"storage_database": "spacedeck",
|
||||
"storage_username": "username",
|
||||
"storage_password": "password",
|
||||
```
|
||||
|
||||
|
||||
# Run with Docker
|
||||
|
||||
- configure `config/default.json`
|
||||
|
||||
Reference in New Issue
Block a user