aboutsummaryrefslogtreecommitdiffstats
path: root/docker
diff options
context:
space:
mode:
authorLibravatar thursday <xthursdayx@mailbox.org>2021-07-18 04:26:56 -0400
committerLibravatar GitHub <noreply@github.com>2021-07-18 04:26:56 -0400
commite67cdfca499a2ef7c8af0102b56aa29806f49904 (patch)
tree4b5efc606a9559454121bbc1127350409734e927 /docker
parentUpdate README.md (diff)
downloadferdium-server-e67cdfca499a2ef7c8af0102b56aa29806f49904.tar.gz
ferdium-server-e67cdfca499a2ef7c8af0102b56aa29806f49904.tar.zst
ferdium-server-e67cdfca499a2ef7c8af0102b56aa29806f49904.zip
Update README.md
Diffstat (limited to 'docker')
-rw-r--r--docker/README.md26
1 files changed, 24 insertions, 2 deletions
diff --git a/docker/README.md b/docker/README.md
index fa7ff78..3d8bd5f 100644
--- a/docker/README.md
+++ b/docker/README.md
@@ -129,14 +129,30 @@ To use a different email sender than the default, SMTP, enter the correct inform
129 129
130## Migrating from an existing Ferdi-server 130## Migrating from an existing Ferdi-server
131 131
132If you are an existing Ferdi-server user using the built-in `SQlite` database, you should include the following variables:
132| Parameter | Function | 133| Parameter | Function |
133| :----: | --- | 134| :----: | --- |
134| `-p 3333:3333` | existing Ferdi-server users will need to update their port mappings from `80:3333` to `3333:3333` | 135| `-p 3333:3333` | existing Ferdi-server users will need to update their container port mappings from `80:3333` to `3333:3333` |
135| `-e DB_PASSWORD=development` | existing Ferdi-server users who use the built-in sqlite database should use the database name `development` | 136| `-e DB_PASSWORD=development` | existing Ferdi-server users who use the built-in sqlite database should use the database name `development` |
136| `-e DATA_DIR=/app/database` | existing Ferdi-server users should add this environmental variable to ensure data persistence | 137| `-e DATA_DIR=/app/database` | existing Ferdi-server users who use the built-in sqlite database should add this environmental variable to ensure data persistence |
137| `-v <path to data on host>=/app/databases` | existing Ferdi-server users who use the built-in sqlite database should use the volume name `/app/database` | 138| `-v <path to data on host>=/app/databases` | existing Ferdi-server users who use the built-in sqlite database should use the volume name `/app/database` |
139
140If you are an existing Ferdi-server user who usees an external database or different variables for the built-in `SQlite` database, you should updatae your parameterse acordingly. For exaple, if you aree using an exterenal MariaDB or MYSql database your unique parameters might look like this:
141| Parameter | Function |
142| :----: | --- |
143| `-e DB_CONNECTION=mysql` | for specifying the database being used |
144| `-e DB_HOST=192.168.10.1` | for specifying the database host machine IP |
145| `-e DB_PORT=3306` | for specifying the database port |
146| `-e DB_USER=ferdi` | for specifying the database user |
147| `-e DB_PASSWORD=ferdipw` | for specifying the database password|
148| `-e DB_DATABASE=adonis` | for specifying the database to be used|
149| `-v <path to database>:/app/database` | this will strore Ferdi-server's database on the docker host for persistence |
150| `-v <path to recipes>:/app/recipes` | this will strore Ferdi-server's recipes on the docker host for persistence |
151
152**In eithr case, pleasee be sure to pass the correct variables to the new Ferdi-server container in order maintain access to your existing database.**
138 153
139## NGINX config block 154## NGINX config block
155
140To access Ferdi-server from outside of your home network on a subdomain use this server block: 156To access Ferdi-server from outside of your home network on a subdomain use this server block:
141 157
142``` 158```
@@ -159,14 +175,17 @@ server {
159``` 175```
160 176
161## Importing your Franz account 177## Importing your Franz account
178
162Ferdi-server allows you to import your full Franz account, including all its settings. 179Ferdi-server allows you to import your full Franz account, including all its settings.
163 180
164To import your Franz account, open `http://[YOUR FERDI-SERVER]/import` in your browser and login using your Franz account details. Ferdi-server will create a new user with the same credentials and copy your Franz settings, services and workspaces. 181To import your Franz account, open `http://[YOUR FERDI-SERVER]/import` in your browser and login using your Franz account details. Ferdi-server will create a new user with the same credentials and copy your Franz settings, services and workspaces.
165 182
166## Transferring user data 183## Transferring user data
184
167Please refer to <https://github.com/getferdi/ferdi/wiki/Transferring-data-between-servers> 185Please refer to <https://github.com/getferdi/ferdi/wiki/Transferring-data-between-servers>
168 186
169## Creating and using custom recipes 187## Creating and using custom recipes
188
170Ferdi-server allows to extends the Franz recipe catalogue with custom Ferdi recipes. 189Ferdi-server allows to extends the Franz recipe catalogue with custom Ferdi recipes.
171 190
172For documentation on how to create a recipe, please visit [the official guide by Franz](https://github.com/meetfranz/plugins/blob/master/docs/integration.md). 191For documentation on how to create a recipe, please visit [the official guide by Franz](https://github.com/meetfranz/plugins/blob/master/docs/integration.md).
@@ -179,6 +198,7 @@ To add your recipe to Ferdi-server, open `http://[YOUR FERDI-SERVER]/new` in you
179- `Recipe files`: Recipe files that you created using the [Franz recipe creation guide](https://github.com/meetfranz/plugins/blob/master/docs/integration.md). Please do *not* package your files beforehand - upload the raw files (you can drag and drop multiple files). Ferdi-server will automatically package and store the recipe in the right format. Please also do not drag and drop or select the whole folder, select the individual files. 198- `Recipe files`: Recipe files that you created using the [Franz recipe creation guide](https://github.com/meetfranz/plugins/blob/master/docs/integration.md). Please do *not* package your files beforehand - upload the raw files (you can drag and drop multiple files). Ferdi-server will automatically package and store the recipe in the right format. Please also do not drag and drop or select the whole folder, select the individual files.
180 199
181### Listing custom recipes 200### Listing custom recipes
201
182Inside Ferdi, searching for `ferdi:custom` will list all your custom recipes. 202Inside Ferdi, searching for `ferdi:custom` will list all your custom recipes.
183 203
184## Support Info 204## Support Info
@@ -191,6 +211,7 @@ Inside Ferdi, searching for `ferdi:custom` will list all your custom recipes.
191Below are the instructions for updating the container to get the most recent version of Ferdi-server: 211Below are the instructions for updating the container to get the most recent version of Ferdi-server:
192 212
193### Via Docker Run/Create 213### Via Docker Run/Create
214
194* Update the image: `docker pull getferdi/ferdi-server` 215* Update the image: `docker pull getferdi/ferdi-server`
195* Stop the running container: `docker stop ferdi-server` 216* Stop the running container: `docker stop ferdi-server`
196* Delete the container: `docker rm ferdi-server` 217* Delete the container: `docker rm ferdi-server`
@@ -199,6 +220,7 @@ Below are the instructions for updating the container to get the most recent ver
199* You can also remove the old dangling images: `docker image prune` 220* You can also remove the old dangling images: `docker image prune`
200 221
201### Via Docker Compose 222### Via Docker Compose
223
202* Update all images: `docker-compose pull` 224* Update all images: `docker-compose pull`
203 * or update a single image: `docker-compose pull ferdi-server` 225 * or update a single image: `docker-compose pull ferdi-server`
204* Let compose update all containers as necessary: `docker-compose up -d` 226* Let compose update all containers as necessary: `docker-compose up -d`