diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 39 |
1 files changed, 20 insertions, 19 deletions
@@ -5,7 +5,7 @@ | |||
5 | # Server | 5 | # Server |
6 | 6 | ||
7 | <p> | 7 | <p> |
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> | 8 | <a href="https://github.com/ferdium/ferdium-server/actions/workflows/docker.yml"><img alt="Build Status" src="https://github.com/ferdium/ferdium-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 --> |
@@ -15,7 +15,7 @@ | |||
15 | 15 | ||
16 | ## Why use a custom server? | 16 | ## Why use a custom server? |
17 | 17 | ||
18 | _Find answers to other frequently asked questions on [getferdi.com/faq](https://getferdi.com/faq/)._ | 18 | _Find answers to other frequently asked questions on [ferdium.org/faq](https://ferdium.org/faq/)._ |
19 | 19 | ||
20 | <details> | 20 | <details> |
21 | <summary>Toggle answer</summary> | 21 | <summary>Toggle answer</summary> |
@@ -30,7 +30,7 @@ A custom server allows you to manage the data of all registered users yourself a | |||
30 | - [x] Workspace support | 30 | - [x] Workspace support |
31 | - [x] Functioning service store | 31 | - [x] Functioning service store |
32 | - [x] User dashboard | 32 | - [x] User dashboard |
33 | - [x] Export/import data to other Ferdi-servers | 33 | - [x] Export/import data to other Ferdium-servers |
34 | - [x] Password recovery | 34 | - [x] Password recovery |
35 | - [x] Recipe update | 35 | - [x] Recipe update |
36 | 36 | ||
@@ -38,12 +38,12 @@ A custom server allows you to manage the data of all registered users yourself a | |||
38 | 38 | ||
39 | <details> | 39 | <details> |
40 | <summary>Setup with Docker</summary> | 40 | <summary>Setup with Docker</summary> |
41 | The easiest way to set up Ferdi-server on your server is with Docker. | 41 | The easiest way to set up Ferdium-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 Ferdium-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 Ferdium 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 environment 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 environment variables to your container at runtime. If you are an existing Ferdium-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 | ||
@@ -56,7 +56,7 @@ After setting up the docker container we recommend you set up an NGINX reverse p | |||
56 | docker create \ | 56 | docker create \ |
57 | --name=ferdium-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=<ferdium-server-url> \ |
60 | -e DB_CONNECTION=<database> \ | 60 | -e DB_CONNECTION=<database> \ |
61 | -e DB_HOST=<yourdbhost> \ | 61 | -e DB_HOST=<yourdbhost> \ |
62 | -e DB_PORT=<yourdbport> \ | 62 | -e DB_PORT=<yourdbport> \ |
@@ -87,7 +87,7 @@ After setting up the docker container we recommend you set up an NGINX reverse p | |||
87 | 87 | ||
88 | 3. Optionally, you can [set up Nginx as a reverse proxy](https://www.digitalocean.com/community/tutorials/how-to-set-up-a-node-js-application-for-production-on-ubuntu-16-04#set-up-nginx-as-a-reverse-proxy-server). | 88 | 3. Optionally, you can [set up Nginx as a reverse proxy](https://www.digitalocean.com/community/tutorials/how-to-set-up-a-node-js-application-for-production-on-ubuntu-16-04#set-up-nginx-as-a-reverse-proxy-server). |
89 | 89 | ||
90 | For more information on configuring the Docker image, please read [the Ferdi docker documentation](./docker/README.md). | 90 | For more information on configuring the Docker image, please read [the Ferdium docker documentation](./docker/README.md). |
91 | </details> | 91 | </details> |
92 | <details> | 92 | <details> |
93 | <summary>Manual setup</summary> | 93 | <summary>Manual setup</summary> |
@@ -112,20 +112,20 @@ For more information on configuring the Docker image, please read [the Ferdi doc | |||
112 | <details> | 112 | <details> |
113 | <summary>Configuration</summary> | 113 | <summary>Configuration</summary> |
114 | 114 | ||
115 | franz-server's configuration is saved inside an `.env` file. Besides AdonisJS's settings, Ferdi-server has the following custom settings: | 115 | Ferdium-server's configuration is saved inside an `.env` file. Besides AdonisJS's settings, Ferdium-server has the following custom settings: |
116 | - `IS_CREATION_ENABLED` (`true` or `false`, default: `true`): Whether to enable the [creation of custom recipes](#creating-and-using-custom-recipes) | 116 | - `IS_CREATION_ENABLED` (`true` or `false`, default: `true`): Whether to enable the [creation of custom recipes](#creating-and-using-custom-recipes) |
117 | - `IS_REGISTRATION_ENABLED` (`true` or `false`, default: `true`): Whether to enable the creation of new user accounts | 117 | - `IS_REGISTRATION_ENABLED` (`true` or `false`, default: `true`): Whether to enable the creation of new user accounts |
118 | - `IS_DASHBOARD_ENABLED` (`true` or `false`, default: `true`): Whether to enable the user dashboard | 118 | - `IS_DASHBOARD_ENABLED` (`true` or `false`, default: `true`): Whether to enable the user dashboard |
119 | - `CONNECT_WITH_FRANZ` (`true` or `false`, default: `true`): Whether to enable connections to the Franz server. By enabling this option, Ferdi-server can: | 119 | - `CONNECT_WITH_FRANZ` (`true` or `false`, default: `true`): Whether to enable connections to the Franz server. By enabling this option, Ferdium-server can: |
120 | - Show the full Franz recipe library instead of only custom recipes | 120 | - Show the full Franz recipe library instead of only custom recipes |
121 | - Import Franz accounts | 121 | - Import Franz accounts |
122 | </details> | 122 | </details> |
123 | <details> | 123 | <details> |
124 | <summary>Importing your Franz account</summary> | 124 | <summary>Importing your Franz/Ferdi account</summary> |
125 | 125 | ||
126 | Ferdium-server allows you to import your full Franz (or Ferdi) account, including all its settings. | 126 | Ferdium-server allows you to import your full Franz/Ferdi account, including all its settings. |
127 | 127 | ||
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. | 128 | To import your Franz/Ferdi account, open `http://[YOUR FERDIUM-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/Ferdi settings, services and workspaces. |
129 | </details> | 129 | </details> |
130 | <details> | 130 | <details> |
131 | <summary>Transferring user data</summary> | 131 | <summary>Transferring user data</summary> |
@@ -136,15 +136,16 @@ Please refer to <https://github.com/getferdi/ferdi/wiki/Transferring-data-betwee | |||
136 | <summary>Creating and using custom recipes</summary> | 136 | <summary>Creating and using custom recipes</summary> |
137 | Ferdium-server allows to extends the Franz/Ferdi recipe catalogue with custom Ferdium 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](https://github.com/ferdium/ferdium-recipes/blob/master/docs/integration.md). |
140 | 140 | ||
141 | To add your recipe to Ferdium-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 FERDIUM-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 |
145 | - `Service ID`: Unique ID for this recipe. Does not contain spaces or special characters (e.g. `google-drive`) | 145 | - `Service ID`: Unique ID for this recipe. Does not contain spaces or special characters (e.g. `google-drive`) |
146 | - `Link to SVG image`: Direct link to a 1024x1024 SVG image 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 | 146 | - `Link to SVG image`: Direct link to a 1024x1024 SVG image 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 |
147 | - `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. | 147 | - `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. |
148 | |||
148 | </details> | 149 | </details> |
149 | <details> | 150 | <details> |
150 | <summary>Listing custom recipes</summary> | 151 | <summary>Listing custom recipes</summary> |
@@ -165,10 +166,10 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d | |||
165 | <!-- markdownlint-disable --> | 166 | <!-- markdownlint-disable --> |
166 | <table> | 167 | <table> |
167 | <tr> | 168 | <tr> |
168 | <td align="center"><a href="https://pogonip.pw/"><img src="https://avatars.githubusercontent.com/u/5242865?v=4?s=100" width="100px;" alt=""/><br /><sub><b>nick</b></sub></a><br /><a href="https://github.com/getferdi/server/commits?author=HuggableSquare" title="Code">💻</a></td> | 169 | <td align="center"><a href="https://pogonip.pw/"><img src="https://avatars.githubusercontent.com/u/5242865?v=4?s=100" width="100px;" alt=""/><br /><sub><b>nick</b></sub></a><br /><a href="https://github.com/ferdium/ferdium-server/commits?author=HuggableSquare" title="Code">💻</a></td> |
169 | <td align="center"><a href="http://code-addict.pl"><img src="https://avatars.githubusercontent.com/u/6313392?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Michał Kostewicz</b></sub></a><br /><a href="https://github.com/getferdi/server/commits?author=k0staa" title="Code">💻</a></td> | 170 | <td align="center"><a href="http://code-addict.pl"><img src="https://avatars.githubusercontent.com/u/6313392?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Michał Kostewicz</b></sub></a><br /><a href="https://github.com/ferdium/ferdium-server/commits?author=k0staa" title="Code">💻</a></td> |
170 | <td align="center"><a href="https://gitlab.com/cromefire_"><img src="https://avatars.githubusercontent.com/u/26320625?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Cromefire_</b></sub></a><br /><a href="https://github.com/getferdi/server/commits?author=cromefire" title="Code">💻</a></td> | 171 | <td align="center"><a href="https://gitlab.com/cromefire_"><img src="https://avatars.githubusercontent.com/u/26320625?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Cromefire_</b></sub></a><br /><a href="https://github.com/ferdium/ferdium-server/commits?author=cromefire" title="Code">💻</a></td> |
171 | <td align="center"><a href="https://omkaragrawal.dev"><img src="https://avatars.githubusercontent.com/u/10913160?v=4?s=100" width="100px;" alt=""/><br /><sub><b>OMKAR AGRAWAL</b></sub></a><br /><a href="https://github.com/getferdi/server/commits?author=Omkaragrawal" title="Code">💻</a></td> | 172 | <td align="center"><a href="https://omkaragrawal.dev"><img src="https://avatars.githubusercontent.com/u/10913160?v=4?s=100" width="100px;" alt=""/><br /><sub><b>OMKAR AGRAWAL</b></sub></a><br /><a href="https://github.com/ferdium/ferdium-server/commits?author=Omkaragrawal" title="Code">💻</a></td> |
172 | </tr> | 173 | </tr> |
173 | </table> | 174 | </table> |
174 | 175 | ||