From 364578b0aac069b1a58f36a0296c689686989244 Mon Sep 17 00:00:00 2001 From: dm Date: Wed, 24 Mar 2021 00:19:37 +0100 Subject: [PATCH] add relative paths to docker --- CHANGELOG.md | 8 ++++++++ README.md | 22 +++++++++------------- docker-compose.yml | 6 ++---- 3 files changed, 19 insertions(+), 17 deletions(-) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..c7d5f2b --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,8 @@ +# Changelog + +## [X.X.X] - 2021-03-23 + +### Changes + +- Replaced phantomjs with puppeteer #169 +- Create Hungarian language pack #174 diff --git a/README.md b/README.md index ede3855..4578be3 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ We appreciate filed issues, pull requests and general discussion. # Features -- Create virtual whiteboards called *Spaces* with virtually unlimited size +- Create virtual whiteboards called _Spaces_ with virtually unlimited size - Drag & drop images, videos and audio from your computer or the web - Write and format text with full control over fonts, colors and style - Draw, annotate and highlight with included graphical shapes @@ -45,7 +45,6 @@ To install all node dependencies, run (do this once) after cloning the repositor 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 @@ -61,7 +60,8 @@ 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 can define text, stroke and fill color in your config/default.json. **You also should include the default colors in your custom swatches palette.** @@ -107,8 +107,8 @@ For advanced media conversion: # Data Storage -By default, media files are uploaded to the ```storage``` folder. -The database is stored in ```database.sqlite``` by default. +By default, media files are uploaded to the `storage` folder. +The database is stored in `database.sqlite` by default. # Other databases (Not officially supported) @@ -129,16 +129,12 @@ Adapt the other values as needed "storage_password": "password", ``` - # Run with Docker - configure `config/default.json` -- configure `volumes` section inside `docker-compose.yml` - - point to `database.sqlite` on the host system - - `touch database.sqlite` if it not exists - - point to `storage/` on the host system - - `mkdir storage/` if it not exists -- start the container with `sudo docker-compose up -f docker-compose.yml -d --build` +- adapt your `docker-compose.yml` if needed. +- start the container with `docker-compose up` + (use `-d` for background process and `--build` for rebuilding the image) # Hacking @@ -155,7 +151,7 @@ Spacedeck Open source code is released under the GNU Affero General Public Licen Spacedeck Open - Web-based Collaborative Whiteboard For Rich Media Copyright (C) 2011-2018 Lukas F. Hartmann, Martin Güther Icons and original CSS design copyright by Thomas Helbig - + This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the diff --git a/docker-compose.yml b/docker-compose.yml index 4823997..8835b96 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -1,5 +1,4 @@ version: "2.0" - services: spacedeck: build: . @@ -7,6 +6,5 @@ services: ports: - "9666:9666" volumes: - - /absolute/path/to/storage:/app/storage - - /absolute/path/to/database.sqlite:/app/database.sqlite - + - ./storage:/app/storage + - ./database.sqlite:/app/database.sqlite