aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorLibravatar thursday <xthursdayx@mailbox.org>2021-07-12 19:52:48 -0400
committerLibravatar GitHub <noreply@github.com>2021-07-12 19:52:48 -0400
commitb185c426ddf1fdecfffac436bd411e3c45b61916 (patch)
treee5d552cd71a10318c7de22fee24de7f51f50d820 /README.md
parentUpdate database.js (diff)
downloadferdium-server-b185c426ddf1fdecfffac436bd411e3c45b61916.tar.gz
ferdium-server-b185c426ddf1fdecfffac436bd411e3c45b61916.tar.zst
ferdium-server-b185c426ddf1fdecfffac436bd411e3c45b61916.zip
Update README.md
Added a warning about the deprecation of config.txt in the docker image, made Ferdi-server capitalization consistent, and fixed grammar throughout.
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 13 insertions, 11 deletions
diff --git a/README.md b/README.md
index 38ab5bc..f3e8845 100644
--- a/README.md
+++ b/README.md
@@ -2,10 +2,10 @@
2 <img src="./logo.png" alt="" width="300"/> 2 <img src="./logo.png" alt="" width="300"/>
3</p> 3</p>
4 4
5# ferdi-server 5# Ferdi-server
6Official Server software for the [Ferdi Messaging Browser](https://getferdi.com) 6Official Server software for the [Ferdi Messaging Browser](https://getferdi.com)
7 7
8- [ferdi-server](#ferdi-server) 8- [Ferdi-server](#ferdi-server)
9 - [Why use a custom Ferdi server?](#why-use-a-custom-ferdi-server) 9 - [Why use a custom Ferdi server?](#why-use-a-custom-ferdi-server)
10 - [Features](#features) 10 - [Features](#features)
11 - [Setup](#setup) 11 - [Setup](#setup)
@@ -16,7 +16,7 @@ Official Server software for the [Ferdi Messaging Browser](https://getferdi.com)
16 - [Transferring user data](#transferring-user-data) 16 - [Transferring user data](#transferring-user-data)
17 - [Creating and using custom recipes](#creating-and-using-custom-recipes) 17 - [Creating and using custom recipes](#creating-and-using-custom-recipes)
18 - [Listing custom recipes](#listing-custom-recipes) 18 - [Listing custom recipes](#listing-custom-recipes)
19 - [Contributing to ferdi-server's development](#contributing-to-ferdi-servers-development) 19 - [Contributing to Ferdi-server's development](#contributing-to-ferdi-servers-development)
20 - [License](#license) 20 - [License](#license)
21 21
22## Why use a custom Ferdi server? 22## Why use a custom Ferdi server?
@@ -30,7 +30,7 @@ If you are not interested in doing this you can use our official instance of Fer
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 Ferdi-servers
34- [ ] Password recovery 34- [ ] Password recovery
35- [ ] Recipe update 35- [ ] Recipe update
36 36
@@ -39,7 +39,9 @@ If you are not interested in doing this you can use our official instance of Fer
39The easiest way to set up Ferdi server on your server is with Docker. 39The easiest way to set up Ferdi server on your server is with Docker.
40 40
41The Docker image can be run as is, with the default sqlite database or you can modifying your ENV variables to use an external database (e.g. MySQL, MariaDB, Postgres, etc). 41The Docker image can be run as is, with the default sqlite database or you can modifying your ENV variables to use an external database (e.g. MySQL, MariaDB, Postgres, etc).
42After setting up the docker container we recommend you to set up an NGINX reverse proxy to access ferdi-server outside of your home network and protect it with an SSL certificate. 42After 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.
43
44**Warning**, please note that the use of the previous `config.txt` is now deprecated. 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.
43 45
441. Pull the Docker image 461. Pull the Docker image
45 47
@@ -126,26 +128,26 @@ Please refer to <https://github.com/getferdi/ferdi/wiki/Transferring-data-betwee
126 128
127## Creating and using custom recipes 129## Creating and using custom recipes
128 130
129ferdi-server allows to extends the Franz recipe catalogue with custom Ferdi recipes. 131Ferdi-server allows to extends the Franz recipe catalogue with custom Ferdi recipes.
130 132
131For documentation on how to create a recipe, please visit [the official guide by Franz](https://github.com/meetfranz/plugins/blob/master/docs/integration.md). 133For documentation on how to create a recipe, please visit [the official guide by Franz](https://github.com/meetfranz/plugins/blob/master/docs/integration.md).
132 134
133To add your recipe to ferdi-server, open `http://[YOUR FERDI-SERVER]/new` in your browser. You can now define the following settings: 135To add your recipe to Ferdi-server, open `http://[YOUR FERDI-SERVER]/new` in your browser. You can now define the following settings:
134 136
135- `Author`: Author who created the recipe 137- `Author`: Author who created the recipe
136- `Name`: Name for your new service. Can contain spaces and unicode characters 138- `Name`: Name for your new service. Can contain spaces and unicode characters
137- `Service ID`: Unique ID for this recipe. Does not contain spaces or special characters (e.g. `google-drive`) 139- `Service ID`: Unique ID for this recipe. Does not contain spaces or special characters (e.g. `google-drive`)
138- `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 140- `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
139- `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. 141- `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.
140 142
141### Listing custom recipes 143### Listing custom recipes
142 144
143Inside Ferdi, searching for `ferdi:custom` will list all your custom recipes. 145Inside Ferdi, searching for `ferdi:custom` will list all of your custom recipes.
144 146
145## Contributing to ferdi-server's development 147## Contributing to Ferdi-server's development
146 148
147We welcome all contributors. Please read the [contributing guidelines](CONTRIBUTING.md) to setup your development machine and proceed. 149We welcome all contributors. Please read the [contributing guidelines](CONTRIBUTING.md) to setup your development machine and proceed.
148 150
149## License 151## License
150 152
151ferdi-server is licensed under the MIT License 153Ferdi-server is licensed under the MIT License