diff options
Diffstat (limited to 'docker/README.md')
-rw-r--r-- | docker/README.md | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/docker/README.md b/docker/README.md index fd5debb..2db02cb 100644 --- a/docker/README.md +++ b/docker/README.md | |||
@@ -63,7 +63,7 @@ To create the docker container with the proper parameters: | |||
63 | 63 | ||
64 | ### docker-compose | 64 | ### docker-compose |
65 | 65 | ||
66 | You can use the provided sample [docker-compose.yml](https://github.com/ferdium/ferdium-server/tree/master/docker/docker-compose.yml) if you are happy with the default environment variables. This will pull the latest image from Docker Hub or use a local copy of the image, which you can build using the instructions provided in the [Building locally section](#building-locally). | 66 | You can use the provided sample [docker-compose.yml](https://github.com/ferdium/ferdium-server/tree/main/docker/docker-compose.yml) if you are happy with the default environment variables. This will pull the latest image from Docker Hub or use a local copy of the image, which you can build using the instructions provided in the [Building locally section](#building-locally). |
67 | 67 | ||
68 | To start the application, use `docker-compose -f docker/docker-compose.yml up -d`. | 68 | To start the application, use `docker-compose -f docker/docker-compose.yml up -d`. |
69 | The server will be launched at [http://localhost:3333/](http://localhost:3333/) address. | 69 | The server will be launched at [http://localhost:3333/](http://localhost:3333/) address. |
@@ -188,14 +188,14 @@ Please refer to <https://github.com/getferdi/ferdi/wiki/Transferring-data-betwee | |||
188 | 188 | ||
189 | Ferdium-server allows to extends the Franz recipe catalogue with custom Ferdi recipes. | 189 | Ferdium-server allows to extends the Franz recipe catalogue with custom Ferdi recipes. |
190 | 190 | ||
191 | For documentation on how to create a recipe, please visit [the official guide](https://github.com/ferdium/ferdium-recipes/blob/master/docs/integration.md). | 191 | For documentation on how to create a recipe, please visit [the official guide](https://github.com/ferdium/ferdium-recipes/blob/main/docs/integration.md). |
192 | 192 | ||
193 | To add your recipe to Ferdium-server, open `http://[YOUR FERDIUM-SERVER]/new` in your browser. You can now define the following settings: | 193 | To add your recipe to Ferdium-server, open `http://[YOUR FERDIUM-SERVER]/new` in your browser. You can now define the following settings: |
194 | - `Author`: Author who created the recipe | 194 | - `Author`: Author who created the recipe |
195 | - `Name`: Name for your new service. Can contain spaces and unicode characters | 195 | - `Name`: Name for your new service. Can contain spaces and unicode characters |
196 | - `Service ID`: Unique ID for this recipe. Does not contain spaces or special characters (e.g. `google-drive`) | 196 | - `Service ID`: Unique ID for this recipe. Does not contain spaces or special characters (e.g. `google-drive`) |
197 | - `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 | 197 | - `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 |
198 | - `Recipe files`: Recipe files that you created using the [recipe creation guide](https://github.com/ferdium/ferdium-recipes/blob/master/docs/integration.md). Please do *not* package your files beforehand - upload the raw files (you can drag and drop multiple files). Ferdium-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 [recipe creation guide](https://github.com/ferdium/ferdium-recipes/blob/main/docs/integration.md). Please do *not* package your files beforehand - upload the raw files (you can drag and drop multiple files). Ferdium-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. |
199 | 199 | ||
200 | ### Listing custom recipes | 200 | ### Listing custom recipes |
201 | 201 | ||
@@ -227,7 +227,7 @@ Below are the instructions for updating the container to get the most recent ver | |||
227 | 227 | ||
228 | ## Building locally | 228 | ## Building locally |
229 | 229 | ||
230 | If you want to build this image locally, please run this command from root of [Ferdium-server repository](https://github.com/ferdium/ferdium-server/tree/master/): | 230 | If you want to build this image locally, please run this command from root of [Ferdium-server repository](https://github.com/ferdium/ferdium-server/tree/main/): |
231 | ``` | 231 | ``` |
232 | docker build \ | 232 | docker build \ |
233 | --no-cache \ | 233 | --no-cache \ |