diff options
Diffstat (limited to 'docker/README.md')
-rw-r--r-- | docker/README.md | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/docker/README.md b/docker/README.md index 6741fca..bb996ae 100644 --- a/docker/README.md +++ b/docker/README.md | |||
@@ -4,7 +4,7 @@ | |||
4 | This is a dockerized version of [Ferdi-server](https://github.com/getferdi/server) running on Alpine Linux and Node.js (v10.16.3). | 4 | This is a dockerized version of [Ferdi-server](https://github.com/getferdi/server) running on Alpine Linux and Node.js (v10.16.3). |
5 | 5 | ||
6 | ## Why use a custom Ferdi-server? | 6 | ## Why use a custom Ferdi-server? |
7 | A custom ferdi-server allows you to experience the full potential of the Ferdi Client. It allows you to use all Premium features (e.g. Workspaces and custom URL recipes) and [add your own recipes](#creating-and-using-custom-recipes). | 7 | A custom Ferdi-server allows you to experience the full potential of the Ferdi Client. It allows you to use all Premium features (e.g. Workspaces and custom URL recipes) and [add your own recipes](#creating-and-using-custom-recipes). |
8 | 8 | ||
9 | ## Features | 9 | ## Features |
10 | - [x] User registration and login | 10 | - [x] User registration and login |
@@ -13,7 +13,7 @@ A custom ferdi-server allows you to experience the full potential of the Ferdi C | |||
13 | - [x] Functioning service store | 13 | - [x] Functioning service store |
14 | - [x] User dashboard | 14 | - [x] User dashboard |
15 | - [x] Password recovery | 15 | - [x] Password recovery |
16 | - [x] Export/import data to other ferdi-servers | 16 | - [x] Export/import data to other Ferdi-servers |
17 | - [ ] Recipe update | 17 | - [ ] Recipe update |
18 | 18 | ||
19 | ## Installation & Setup | 19 | ## Installation & Setup |
@@ -171,7 +171,7 @@ To add your recipe to Ferdi-server, open `http://[YOUR FERDI-SERVER]/new` in you | |||
171 | - `Name`: Name for your new service. Can contain spaces and unicode characters | 171 | - `Name`: Name for your new service. Can contain spaces and unicode characters |
172 | - `Service ID`: Unique ID for this recipe. Does not contain spaces or special characters (e.g. `google-drive`) | 172 | - `Service ID`: Unique ID for this recipe. Does not contain spaces or special characters (e.g. `google-drive`) |
173 | - `Link to PNG/SVG image`: Direct link to a 1024x1024 PNG image and SVG that is used as a logo inside the store. Please use jsDelivr when using a file uploaded to GitHub as raw.githubusercontent files won't load | 173 | - `Link to PNG/SVG image`: Direct link to a 1024x1024 PNG image and SVG that is used as a logo inside the store. Please use jsDelivr when using a file uploaded to GitHub as raw.githubusercontent files won't load |
174 | - `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. | 174 | - `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. |
175 | 175 | ||
176 | ### Listing custom recipes | 176 | ### Listing custom recipes |
177 | Inside Ferdi, searching for `ferdi:custom` will list all your custom recipes. | 177 | Inside Ferdi, searching for `ferdi:custom` will list all your custom recipes. |
@@ -202,7 +202,7 @@ Below are the instructions for updating the container to get the most recent ver | |||
202 | 202 | ||
203 | ## Building locally | 203 | ## Building locally |
204 | 204 | ||
205 | If you want to build this image locally, please run this command from root of [ferdi server repository](https://github.com/getferdi/server/tree/master/): | 205 | If you want to build this image locally, please run this command from root of [Ferdi-server repository](https://github.com/getferdi/server/tree/master/): |
206 | ``` | 206 | ``` |
207 | docker build \ | 207 | docker build \ |
208 | --no-cache \ | 208 | --no-cache \ |
@@ -211,4 +211,4 @@ docker build \ | |||
211 | ``` | 211 | ``` |
212 | 212 | ||
213 | ## License | 213 | ## License |
214 | Ferdi-server-docker and ferdi-server are licensed under the MIT License. | 214 | Ferdi-server-docker and Ferdi-server are licensed under the MIT License. |