diff options
author | vantezzen <properly@protonmail.com> | 2019-09-03 10:23:38 +0200 |
---|---|---|
committer | vantezzen <properly@protonmail.com> | 2019-09-03 10:23:38 +0200 |
commit | 9355fb1c3f321a696476eec342a058722d2a0796 (patch) | |
tree | 6f93cca1103c0f2b3bd30834e481659e46bfbef7 /README.md | |
parent | Add service deleting (diff) | |
download | ferdium-server-9355fb1c3f321a696476eec342a058722d2a0796.tar.gz ferdium-server-9355fb1c3f321a696476eec342a058722d2a0796.tar.zst ferdium-server-9355fb1c3f321a696476eec342a058722d2a0796.zip |
Extend README
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 28 |
1 files changed, 24 insertions, 4 deletions
@@ -1,8 +1,6 @@ | |||
1 | # ferdi-server | 1 | # ferdi-server |
2 | Unofficial Franz server replacement for use with the Ferdi Client. | 2 | Unofficial Franz server replacement for use with the Ferdi Client. |
3 | 3 | ||
4 | ⚠️ Currently not to be used publicly/productively as there are no validations etc. yet. | ||
5 | |||
6 | ## Features | 4 | ## Features |
7 | - [x] User registration and login | 5 | - [x] User registration and login |
8 | - [x] Service creation, download, listing and removing | 6 | - [x] Service creation, download, listing and removing |
@@ -12,14 +10,36 @@ Unofficial Franz server replacement for use with the Ferdi Client. | |||
12 | ## Setup | 10 | ## Setup |
13 | 1. Clone this repository | 11 | 1. Clone this repository |
14 | 2. Install the [AdonisJS CLI](https://adonisjs.com/) | 12 | 2. Install the [AdonisJS CLI](https://adonisjs.com/) |
15 | 3. Run the database migrations with | 13 | 3. Copy `.env.example` to `.env` and edit the [configuration](#configuration) to your needs |
14 | 4. Run the database migrations with | ||
16 | ```js | 15 | ```js |
17 | adonis migration:run | 16 | adonis migration:run |
18 | ``` | 17 | ``` |
19 | 4. Start the server with | 18 | 5. Start the server with |
20 | ```js | 19 | ```js |
21 | adonis serve --dev | 20 | adonis serve --dev |
22 | ``` | 21 | ``` |
23 | 22 | ||
23 | ## Configuration | ||
24 | franz-server's configuration is saved inside the `.env` file. Besides AdonisJS's settings, ferdi-server has the following custom settings: | ||
25 | - `IS_CREATION_ENABLED` (`true` or `false`): Whether to enable the [creation of custom recipes](#creating-and-using-custom-recipes) | ||
26 | |||
27 | ## Importing your Franz account | ||
28 | ferdi-server allows you to import your full Franz account, including all its settings. | ||
29 | |||
30 | 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. | ||
31 | |||
32 | ## Creating and using custom recipes | ||
33 | ferdi-server allows to extends the Franz recipe catalogue with custom Ferdi recipes. | ||
34 | |||
35 | 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). | ||
36 | |||
37 | To add your recipe to ferdi-server, open `http://[YOUR FERDI-SERVER]/new` in your browser. You can now define the following settings: | ||
38 | - `Author`: Author who created the recipe | ||
39 | - `Name`: Name for your new service. Can contain spaces and unicode characters | ||
40 | - `Service ID`: Unique ID for this recipe. Does not contain spaces or special characters (e.g. `google-drive`) | ||
41 | - `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 | ||
42 | - `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. | ||
43 | |||
24 | ## License | 44 | ## License |
25 | ferdi-server is licensed under the MIT License | 45 | ferdi-server is licensed under the MIT License |