diff options
-rw-r--r-- | README.md | 22 |
1 files changed, 11 insertions, 11 deletions
@@ -5,13 +5,13 @@ | |||
5 | # Server | 5 | # Server |
6 | 6 | ||
7 | <p> | 7 | <p> |
8 | <a href="https://github.com/getferdi/server/actions/workflows/builds.yml"><img alt="Build Status" src="https://github.com/getferdi/server/actions/workflows/builds.yml/badge.svg?branch=master&event=push"></a> | 8 | <a href="https://github.com/ferdium/ferdium-server/actions/workflows/docker.yml"><img alt="Build Status" src="https://github.com/getferdi/server/actions/workflows/builds.yml/badge.svg?branch=master&event=push"></a> |
9 | <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --> | 9 | <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --> |
10 | <a href='#contributors-'><img src='https://img.shields.io/badge/contributors-4-default.svg?logo=github' alt='Contributors'/></a> | 10 | <a href='#contributors-'><img src='https://img.shields.io/badge/contributors-4-default.svg?logo=github' alt='Contributors'/></a> |
11 | <!-- ALL-CONTRIBUTORS-BADGE:END --> | 11 | <!-- ALL-CONTRIBUTORS-BADGE:END --> |
12 | </p> | 12 | </p> |
13 | 13 | ||
14 | > 👨🏾🍳 Server for [Ferdi](https://getferdi.com) that you can re-use to run your own | 14 | > 👨🏾🍳 Server for [Ferdium](https://ferdium.org) that you can re-use to run your own |
15 | 15 | ||
16 | ## Why use a custom server? | 16 | ## Why use a custom server? |
17 | 17 | ||
@@ -20,7 +20,7 @@ _Find answers to other frequently asked questions on [getferdi.com/faq](https:// | |||
20 | <details> | 20 | <details> |
21 | <summary>Toggle answer</summary> | 21 | <summary>Toggle answer</summary> |
22 | 22 | ||
23 | A custom server allows you to manage the data of all registered users yourself and add your own recipes to the repository. If you are not interested in doing this you can use our official instance of the server at [api.getferdi.com](https://api.getferdi.com). | 23 | A custom server allows you to manage the data of all registered users yourself and add your own recipes to the repository. If you are not interested in doing this you can use our official instance of the server at [api.ferdium.org](https://api.ferdium.org). |
24 | 24 | ||
25 | </details> | 25 | </details> |
26 | 26 | ||
@@ -41,9 +41,9 @@ A custom server allows you to manage the data of all registered users yourself a | |||
41 | The easiest way to set up Ferdi-server on your server is with Docker. | 41 | The easiest way to set up Ferdi-server on your server is with Docker. |
42 | 42 | ||
43 | The Docker image can be run as is, with the default SQLite database or you can modify your ENV variables to use an external database (e.g. MySQL, MariaDB, Postgres, etc). | 43 | The Docker image can be run as is, with the default SQLite database or you can modify your ENV variables to use an external database (e.g. MySQL, MariaDB, Postgres, etc). |
44 | After setting up the docker container we recommend you set up an NGINX reverse proxy to access Ferdi-server outside of your home network and protect it with an SSL certificate. | 44 | After setting up the docker container we recommend you set up an NGINX reverse proxy to access Ferdium-server outside of your home network and protect it with an SSL certificate. |
45 | 45 | ||
46 | **Warning**, please note that the use of the previous `config.txt` is now deprecated and a number of environmental variables have changed, specifically the default database name and location, the internal container port, and an additional `DATA_DIR` variable has been added. Make sure to pass the correct environmental variables to your container at runtime. If you are an existing Ferdi-server user, please see [the Ferdi docker documentation](./docker/README.md) for more information about migrating to the new image. | 46 | **Warning**, please note that the use of the previous `config.txt` is now deprecated and a number of environmental variables have changed, specifically the default database name and location, the internal container port, and an additional `DATA_DIR` variable has been added. Make sure to pass the correct environmental variables to your container at runtime. If you are an existing Ferdi-server user, please see [the Ferdium docker documentation](./docker/README.md) for more information about migrating to the new image. |
47 | 47 | ||
48 | 1. Pull the Docker image | 48 | 1. Pull the Docker image |
49 | 49 | ||
@@ -54,7 +54,7 @@ After setting up the docker container we recommend you set up an NGINX reverse p | |||
54 | 54 | ||
55 | ```sh | 55 | ```sh |
56 | docker create \ | 56 | docker create \ |
57 | --name=ferdi-server \ | 57 | --name=ferdium-server \ |
58 | -e NODE_ENV=development \ | 58 | -e NODE_ENV=development \ |
59 | -e APP_URL=<ferdi-server-url> \ | 59 | -e APP_URL=<ferdi-server-url> \ |
60 | -e DB_CONNECTION=<database> \ | 60 | -e DB_CONNECTION=<database> \ |
@@ -123,9 +123,9 @@ franz-server's configuration is saved inside an `.env` file. Besides AdonisJS's | |||
123 | <details> | 123 | <details> |
124 | <summary>Importing your Franz account</summary> | 124 | <summary>Importing your Franz account</summary> |
125 | 125 | ||
126 | Ferdi-server allows you to import your full Franz account, including all its settings. | 126 | Ferdium-server allows you to import your full Franz (or Ferdi) account, including all its settings. |
127 | 127 | ||
128 | To 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. | 128 | To import your Franz/Ferdi account, open `http://[YOUR FERDI-SERVER]/import` in your browser and login using your Franz/Ferdi account details. Ferdium-server will create a new user with the same credentials and copy your Franz settings, services and workspaces. |
129 | </details> | 129 | </details> |
130 | <details> | 130 | <details> |
131 | <summary>Transferring user data</summary> | 131 | <summary>Transferring user data</summary> |
@@ -134,11 +134,11 @@ Please refer to <https://github.com/getferdi/ferdi/wiki/Transferring-data-betwee | |||
134 | </details> | 134 | </details> |
135 | <details> | 135 | <details> |
136 | <summary>Creating and using custom recipes</summary> | 136 | <summary>Creating and using custom recipes</summary> |
137 | Ferdi-server allows to extends the Franz recipe catalogue with custom Ferdi recipes. | 137 | Ferdium-server allows to extends the Franz/Ferdi recipe catalogue with custom Ferdium recipes. |
138 | 138 | ||
139 | For documentation on how to create a recipe, please visit [the official guide by Franz](https://github.com/meetfranz/plugins/blob/master/docs/integration.md). | 139 | For documentation on how to create a recipe, please visit [the official guide by Franz](https://github.com/meetfranz/plugins/blob/master/docs/integration.md). |
140 | 140 | ||
141 | To add your recipe to Ferdi-server, open `http://[YOUR FERDI-SERVER]/new` in your browser. You can now define the following settings: | 141 | To add your recipe to Ferdium-server, open `http://[YOUR FERDI-SERVER]/new` in your browser. You can now define the following settings: |
142 | 142 | ||
143 | - `Author`: Author who created the recipe | 143 | - `Author`: Author who created the recipe |
144 | - `Name`: Name for your new service. Can contain spaces and unicode characters | 144 | - `Name`: Name for your new service. Can contain spaces and unicode characters |
@@ -149,7 +149,7 @@ To add your recipe to Ferdi-server, open `http://[YOUR FERDI-SERVER]/new` in you | |||
149 | <details> | 149 | <details> |
150 | <summary>Listing custom recipes</summary> | 150 | <summary>Listing custom recipes</summary> |
151 | 151 | ||
152 | Inside Ferdi, searching for `ferdi:custom` will list all of your custom recipes. | 152 | Inside Ferdium, searching for `ferdium:custom` will list all of your custom recipes. |
153 | </details> | 153 | </details> |
154 | 154 | ||
155 | ## Contributing | 155 | ## Contributing |