aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLibravatar Vijay Aravamudhan <vraravam@users.noreply.github.com>2022-04-24 12:23:44 -0500
committerLibravatar GitHub <noreply@github.com>2022-04-24 12:23:44 -0500
commit442ef142fc4bd7c430d8a1314535f03576f616f6 (patch)
tree10d8df84e8c5ba68b7dd0bf6bc1e0add6a766b63
parentfix: branding on README.md (diff)
downloadferdium-server-442ef142fc4bd7c430d8a1314535f03576f616f6.tar.gz
ferdium-server-442ef142fc4bd7c430d8a1314535f03576f616f6.tar.zst
ferdium-server-442ef142fc4bd7c430d8a1314535f03576f616f6.zip
Rebranded from 'ferdi' to 'ferdium' (#4)
-rw-r--r--.all-contributorsrc4
-rw-r--r--.do/deploy.template.yaml20
-rw-r--r--.env.example6
-rw-r--r--CONTRIBUTING.md20
-rw-r--r--LICENSE2
-rw-r--r--README.md39
-rw-r--r--app/Controllers/Http/DashboardController.js4
-rw-r--r--app/Controllers/Http/RecipeController.js2
-rw-r--r--app/Controllers/Http/StaticController.js12
-rw-r--r--app/Controllers/Http/UserController.js7
-rw-r--r--config/database.js6
-rw-r--r--docker/README.md144
-rw-r--r--docker/docker-compose.yml16
-rwxr-xr-xdocker/entrypoint.sh26
-rw-r--r--package-lock.json2
-rw-r--r--package.json4
-rw-r--r--resources/announcements/version.json8
-rw-r--r--resources/views/dashboard/account.edge2
-rw-r--r--resources/views/dashboard/delete.edge2
-rw-r--r--resources/views/dashboard/login.edge2
-rw-r--r--resources/views/dashboard/transfer.edge2
-rw-r--r--resources/views/layouts/main.edge2
-rw-r--r--resources/views/layouts/v2.edge4
-rw-r--r--resources/views/others/import.edge6
-rw-r--r--resources/views/others/index.edge4
-rw-r--r--resources/views/others/new.edge4
-rw-r--r--start/events.js4
-rw-r--r--start/routes.js2
28 files changed, 180 insertions, 176 deletions
diff --git a/.all-contributorsrc b/.all-contributorsrc
index 43e8f1c..ce730aa 100644
--- a/.all-contributorsrc
+++ b/.all-contributorsrc
@@ -44,8 +44,8 @@
44 } 44 }
45 ], 45 ],
46 "contributorsPerLine": 7, 46 "contributorsPerLine": 7,
47 "projectName": "server", 47 "projectName": "ferdium-server",
48 "projectOwner": "getferdi", 48 "projectOwner": "ferdium",
49 "repoType": "github", 49 "repoType": "github",
50 "repoHost": "https://github.com", 50 "repoHost": "https://github.com",
51 "skipCi": true 51 "skipCi": true
diff --git a/.do/deploy.template.yaml b/.do/deploy.template.yaml
index a17a225..f4321fd 100644
--- a/.do/deploy.template.yaml
+++ b/.do/deploy.template.yaml
@@ -4,43 +4,43 @@ spec:
4 - rule: DOMAIN_FAILED 4 - rule: DOMAIN_FAILED
5 databases: 5 databases:
6 - engine: PG 6 - engine: PG
7 name: ferdi-db 7 name: ferdium-db
8 num_nodes: 1 8 num_nodes: 1
9 size: db-s-dev-database 9 size: db-s-dev-database
10 version: "12" 10 version: "12"
11 name: ferdi-server 11 name: ferdium-server
12 region: lon 12 region: lon
13 services: 13 services:
14 - dockerfile_path: Dockerfile 14 - dockerfile_path: Dockerfile
15 git: 15 git:
16 branch: master 16 branch: master
17 repo_clone_url: https://github.com/getferdi/server.git 17 repo_clone_url: https://github.com/ferdium/ferdium-server.git
18 envs: 18 envs:
19 - key: DB_HOST 19 - key: DB_HOST
20 scope: RUN_AND_BUILD_TIME 20 scope: RUN_AND_BUILD_TIME
21 value: ${ferdi-db.HOSTNAME} 21 value: ${ferdium-db.HOSTNAME}
22 - key: DB_PORT 22 - key: DB_PORT
23 scope: RUN_AND_BUILD_TIME 23 scope: RUN_AND_BUILD_TIME
24 value: ${ferdi-db.PORT} 24 value: ${ferdium-db.PORT}
25 - key: DB_USER 25 - key: DB_USER
26 scope: RUN_AND_BUILD_TIME 26 scope: RUN_AND_BUILD_TIME
27 value: ${ferdi-db.USERNAME} 27 value: ${ferdium-db.USERNAME}
28 - key: DB_PASSWORD 28 - key: DB_PASSWORD
29 scope: RUN_AND_BUILD_TIME 29 scope: RUN_AND_BUILD_TIME
30 value: ${ferdi-db.PASSWORD} 30 value: ${ferdium-db.PASSWORD}
31 - key: DB_DATABASE 31 - key: DB_DATABASE
32 scope: RUN_AND_BUILD_TIME 32 scope: RUN_AND_BUILD_TIME
33 value: ${ferdi-db.DATABASE} 33 value: ${ferdium-db.DATABASE}
34 - key: DB_CA_CERT 34 - key: DB_CA_CERT
35 scope: RUN_AND_BUILD_TIME 35 scope: RUN_AND_BUILD_TIME
36 value: ${ferdi-db.CA_CERT} 36 value: ${ferdium-db.CA_CERT}
37 - key: DB_CONNECTION 37 - key: DB_CONNECTION
38 scope: RUN_AND_BUILD_TIME 38 scope: RUN_AND_BUILD_TIME
39 value: pg 39 value: pg
40 http_port: 8080 40 http_port: 8080
41 instance_count: 1 41 instance_count: 1
42 instance_size_slug: basic-xxs 42 instance_size_slug: basic-xxs
43 name: ferdi-server 43 name: ferdium-server
44 routes: 44 routes:
45 - path: / 45 - path: /
46 source_dir: / 46 source_dir: /
diff --git a/.env.example b/.env.example
index 36ae547..884ab50 100644
--- a/.env.example
+++ b/.env.example
@@ -2,7 +2,7 @@ HOST=127.0.0.1
2PORT=3333 2PORT=3333
3NODE_ENV=development 3NODE_ENV=development
4 4
5APP_NAME=Ferdi-server 5APP_NAME=Ferdium-server
6APP_URL=localhost 6APP_URL=localhost
7 7
8CACHE_VIEWS=false 8CACHE_VIEWS=false
@@ -16,7 +16,7 @@ DB_HOST=127.0.0.1
16DB_PORT=3306 16DB_PORT=3306
17DB_USER=root 17DB_USER=root
18DB_PASSWORD= 18DB_PASSWORD=
19DB_DATABASE=ferdi 19DB_DATABASE=ferdium
20DB_SSL=false 20DB_SSL=false
21 21
22PUID=1000 22PUID=1000
@@ -34,5 +34,5 @@ SMTP_PORT=2525
34SMTP_HOST=127.0.0.1 34SMTP_HOST=127.0.0.1
35MAIL_USERNAME=username 35MAIL_USERNAME=username
36MAIL_PASSWORD=password 36MAIL_PASSWORD=password
37MAIL_SENDER=noreply@getferdi.com 37MAIL_SENDER=noreply@ferdium.org
38MAIL_SSL=true 38MAIL_SSL=true
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index a0b4c0b..46bb4e4 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,12 +1,12 @@
1# Contributing to ferdi-server 1# Contributing to ferdium-server
2 2
3:tada: First off, thanks for taking the time and your effort to make Ferdi better! :tada: 3:tada: First off, thanks for taking the time and your effort to make Ferdium better! :tada:
4 4
5## Table of contents 5## Table of contents
6 6
7<!-- TOC depthFrom:2 depthTo:2 withLinks:1 updateOnSave:1 orderedList:0 --> 7<!-- TOC depthFrom:2 depthTo:2 withLinks:1 updateOnSave:1 orderedList:0 -->
8 8
9- [Contributing to ferdi-server](#contributing-to-ferdi-server) 9- [Contributing to ferdium-server](#contributing-to-ferdium-server)
10 - [Table of contents](#table-of-contents) 10 - [Table of contents](#table-of-contents)
11 - [Code of Conduct](#code-of-conduct) 11 - [Code of Conduct](#code-of-conduct)
12 - [What should I know before I get started?](#what-should-i-know-before-i-get-started) 12 - [What should I know before I get started?](#what-should-i-know-before-i-get-started)
@@ -26,15 +26,15 @@
26 26
27## Code of Conduct 27## Code of Conduct
28 28
29This project and everyone participating in it is governed by the [Ferdi Code of Conduct](https://github.com/getferdi/ferdi/blob/develop/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [stefan@adlk.io](mailto:stefan@adlk.io). 29This project and everyone participating in it is governed by the [Ferdium Code of Conduct](https://github.com/ferdium/ferdium-app/blob/develop/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [hello@ferdium.org](mailto:hello@ferdium.org).
30 30
31## What should I know before I get started? 31## What should I know before I get started?
32 32
33For the moment, Ferdi's development is a bit slow but all contributions are highly appreciated. [Check this issue for discussion](https://github.com/getferdi/ferdi/issues/956). 33For the moment, Ferdium's development is just getting started but all contributions (code, testing, bug-logging, feature-suggestions) are highly appreciated.
34 34
35## How Can I Contribute? 35## How Can I Contribute?
36 36
37As a basic rule, before filing issues, feature requests or anything else. Take a look at the issues and check if this has not already been reported by another user. If so, engage in the already existing discussion. 37As a basic rule, before filing issues, feature requests or anything else, please take a look at the issues and check if this has not already been reported by another user. If so, engage in the already existing discussion.
38 38
39## Setting up your Development machine 39## Setting up your Development machine
40 40
@@ -83,16 +83,16 @@ npm i -g windows-build-tools --vs2015
83### Clone repository with submodule 83### Clone repository with submodule
84 84
85```bash 85```bash
86git clone https://github.com/getferdi/server.git 86git clone https://github.com/ferdium/ferdium-server.git
87cd server 87cd ferdium-server
88git submodule update --init --recursive 88git submodule update --init --recursive --remote --rebase --force
89``` 89```
90 90
91It is important you execute the last command to get the required submodules (recipes). 91It is important you execute the last command to get the required submodules (recipes).
92 92
93### Install dependencies 93### Install dependencies
94 94
95- Run the following command to install all dependencies, and link sibling modules with ferdi-server. 95- Run the following command to install all dependencies, and link sibling modules with ferdium-server.
96 96
97```bash 97```bash
98npm i 98npm i
diff --git a/LICENSE b/LICENSE
index 1633187..d4e0e9d 100644
--- a/LICENSE
+++ b/LICENSE
@@ -1,6 +1,6 @@
1MIT License 1MIT License
2 2
3Copyright (c) 2019 Ferdi 3Copyright (c) 2022 Ferdium Contributors
4 4
5Permission is hereby granted, free of charge, to any person obtaining a copy 5Permission is hereby granted, free of charge, to any person obtaining a copy
6of this software and associated documentation files (the "Software"), to deal 6of this software and associated documentation files (the "Software"), to deal
diff --git a/README.md b/README.md
index 5dc0b3d..0668955 100644
--- a/README.md
+++ b/README.md
@@ -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>
41The easiest way to set up Ferdi-server on your server is with Docker. 41The easiest way to set up Ferdium-server on your server is with Docker.
42 42
43The 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). 43The 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).
44After 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. 44After 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
481. Pull the Docker image 481. 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
883. 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). 883. 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
90For more information on configuring the Docker image, please read [the Ferdi docker documentation](./docker/README.md). 90For 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
115franz-server's configuration is saved inside an `.env` file. Besides AdonisJS's settings, Ferdi-server has the following custom settings: 115Ferdium-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
126Ferdium-server allows you to import your full Franz (or Ferdi) account, including all its settings. 126Ferdium-server allows you to import your full Franz/Ferdi account, including all its settings.
127 127
128To 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. 128To 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>
137Ferdium-server allows to extends the Franz/Ferdi recipe catalogue with custom Ferdium recipes. 137Ferdium-server allows to extends the Franz/Ferdi recipe catalogue with custom Ferdium recipes.
138 138
139For documentation on how to create a recipe, please visit [the official guide by Franz](https://github.com/meetfranz/plugins/blob/master/docs/integration.md). 139For 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
141To add your recipe to Ferdium-server, open `http://[YOUR FERDI-SERVER]/new` in your browser. You can now define the following settings: 141To 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
diff --git a/app/Controllers/Http/DashboardController.js b/app/Controllers/Http/DashboardController.js
index 84a88a9..e7c38c2 100644
--- a/app/Controllers/Http/DashboardController.js
+++ b/app/Controllers/Http/DashboardController.js
@@ -222,14 +222,14 @@ class DashboardController {
222 try { 222 try {
223 file = JSON.parse(request.input('file')); 223 file = JSON.parse(request.input('file'));
224 } catch (e) { 224 } catch (e) {
225 session.flash({ type: 'danger', message: 'Invalid Ferdi account file' }); 225 session.flash({ type: 'danger', message: 'Invalid Ferdium account file' });
226 return response.redirect('back'); 226 return response.redirect('back');
227 } 227 }
228 228
229 if (!file || !file.services || !file.workspaces) { 229 if (!file || !file.services || !file.workspaces) {
230 session.flash({ 230 session.flash({
231 type: 'danger', 231 type: 'danger',
232 message: 'Invalid Ferdi account file (2)', 232 message: 'Invalid Ferdium account file (2)',
233 }); 233 });
234 return response.redirect('back'); 234 return response.redirect('back');
235 } 235 }
diff --git a/app/Controllers/Http/RecipeController.js b/app/Controllers/Http/RecipeController.js
index 4fad74e..cbdddaf 100644
--- a/app/Controllers/Http/RecipeController.js
+++ b/app/Controllers/Http/RecipeController.js
@@ -136,7 +136,7 @@ class RecipeController {
136 // Get results 136 // Get results
137 let results; 137 let results;
138 138
139 if (needle === 'ferdi:custom') { 139 if (needle === 'ferdium:custom') {
140 const dbResults = (await Recipe.all()).toJSON(); 140 const dbResults = (await Recipe.all()).toJSON();
141 results = dbResults.map((recipe) => ({ 141 results = dbResults.map((recipe) => ({
142 id: recipe.recipeId, 142 id: recipe.recipeId,
diff --git a/app/Controllers/Http/StaticController.js b/app/Controllers/Http/StaticController.js
index aad1059..abba249 100644
--- a/app/Controllers/Http/StaticController.js
+++ b/app/Controllers/Http/StaticController.js
@@ -31,8 +31,8 @@ class StaticController {
31 isTodosEnabled: true, 31 isTodosEnabled: true,
32 isTodosIncludedInCurrentPlan: true, 32 isTodosIncludedInCurrentPlan: true,
33 defaultTrialPlan: 'franz-pro-yearly', 33 defaultTrialPlan: 'franz-pro-yearly',
34 subscribeURL: 'https://getferdi.com', 34 subscribeURL: 'https://ferdium.org',
35 planSelectionURL: 'https://getferdi.com', 35 planSelectionURL: 'https://ferdium.org',
36 hasInlineCheckout: true, 36 hasInlineCheckout: true,
37 isPlanSelectionEnabled: false, 37 isPlanSelectionEnabled: false,
38 isTrialStatusBarEnabled: false, 38 isTrialStatusBarEnabled: false,
@@ -43,24 +43,24 @@ class StaticController {
43 plans: { 43 plans: {
44 personal: { 44 personal: {
45 monthly: { 45 monthly: {
46 id: 'ferdi-free', 46 id: 'ferdium-free',
47 price: 0, 47 price: 0,
48 billed: 0, 48 billed: 0,
49 }, 49 },
50 yearly: { 50 yearly: {
51 id: 'ferdi-completely-free', 51 id: 'ferdium-completely-free',
52 price: 0, 52 price: 0,
53 billed: 0, 53 billed: 0,
54 }, 54 },
55 }, 55 },
56 pro: { 56 pro: {
57 monthly: { 57 monthly: {
58 id: 'ferdi-still-free', 58 id: 'ferdium-still-free',
59 price: 0, 59 price: 0,
60 billed: 0, 60 billed: 0,
61 }, 61 },
62 yearly: { 62 yearly: {
63 id: 'ferdi-forever-free', 63 id: 'ferdium-forever-free',
64 price: 0, 64 price: 0,
65 billed: 0, 65 billed: 0,
66 }, 66 },
diff --git a/app/Controllers/Http/UserController.js b/app/Controllers/Http/UserController.js
index 99336cb..aef7f01 100644
--- a/app/Controllers/Http/UserController.js
+++ b/app/Controllers/Http/UserController.js
@@ -10,11 +10,12 @@ const fetch = require('node-fetch');
10const { v4: uuid } = require('uuid'); 10const { v4: uuid } = require('uuid');
11const crypto = require('crypto'); 11const crypto = require('crypto');
12 12
13// TODO: This whole controller needs to be changed such that it can support importing from both Franz and Ferdi
13const franzRequest = (route, method, auth) => 14const franzRequest = (route, method, auth) =>
14 new Promise((resolve, reject) => { 15 new Promise((resolve, reject) => {
15 const base = 'https://api.franzinfra.com/v1/'; 16 const base = 'https://api.franzinfra.com/v1/';
16 const user = 17 const user =
17 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/537.36 (KHTML, like Gecko) Ferdi/5.3.0-beta.1 Chrome/69.0.3497.128 Electron/4.2.4 Safari/537.36'; 18 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/537.36 (KHTML, like Gecko) Franz/5.3.0-beta.1 Chrome/69.0.3497.128 Electron/4.2.4 Safari/537.36';
18 19
19 try { 20 try {
20 fetch(base + route, { 21 fetch(base + route, {
@@ -247,7 +248,7 @@ class UserController {
247 248
248 const base = 'https://api.franzinfra.com/v1/'; 249 const base = 'https://api.franzinfra.com/v1/';
249 const userAgent = 250 const userAgent =
250 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/537.36 (KHTML, like Gecko) Ferdi/5.3.0-beta.1 Chrome/69.0.3497.128 Electron/4.2.4 Safari/537.36'; 251 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/537.36 (KHTML, like Gecko) Franz/5.3.0-beta.1 Chrome/69.0.3497.128 Electron/4.2.4 Safari/537.36';
251 252
252 // Try to get an authentication token 253 // Try to get an authentication token
253 let token; 254 let token;
@@ -377,7 +378,7 @@ class UserController {
377 } 378 }
378 379
379 return response.send( 380 return response.send(
380 'Your account has been imported. You can now use your Franz account in Ferdi.', 381 'Your account has been imported. You can now use your Franz/Ferdi account in Ferdium.',
381 ); 382 );
382 } 383 }
383} 384}
diff --git a/config/database.js b/config/database.js
index de86a6c..5c51996 100644
--- a/config/database.js
+++ b/config/database.js
@@ -32,7 +32,7 @@ module.exports = {
32 sqlite: { 32 sqlite: {
33 client: 'sqlite3', 33 client: 'sqlite3',
34 connection: { 34 connection: {
35 filename: path.join(Env.get('DATA_DIR', 'data'), `${Env.get('DB_DATABASE', 'ferdi')}.sqlite`), 35 filename: path.join(Env.get('DATA_DIR', 'data'), `${Env.get('DB_DATABASE', 'ferdium')}.sqlite`),
36 }, 36 },
37 useNullAsDefault: true, 37 useNullAsDefault: true,
38 debug: Env.get('DB_DEBUG', false), 38 debug: Env.get('DB_DEBUG', false),
@@ -55,7 +55,7 @@ module.exports = {
55 port: Env.get('DB_PORT', ''), 55 port: Env.get('DB_PORT', ''),
56 user: Env.get('DB_USER', 'root'), 56 user: Env.get('DB_USER', 'root'),
57 password: Env.get('DB_PASSWORD', ''), 57 password: Env.get('DB_PASSWORD', ''),
58 database: Env.get('DB_DATABASE', 'ferdi'), 58 database: Env.get('DB_DATABASE', 'ferdium'),
59 }, 59 },
60 debug: Env.get('DB_DEBUG', false), 60 debug: Env.get('DB_DEBUG', false),
61 }, 61 },
@@ -77,7 +77,7 @@ module.exports = {
77 port: Env.get('DB_PORT', ''), 77 port: Env.get('DB_PORT', ''),
78 user: Env.get('DB_USER', 'root'), 78 user: Env.get('DB_USER', 'root'),
79 password: Env.get('DB_PASSWORD', ''), 79 password: Env.get('DB_PASSWORD', ''),
80 database: Env.get('DB_DATABASE', 'ferdi'), 80 database: Env.get('DB_DATABASE', 'ferdium'),
81 ssl: Env.get('DB_CA_CERT') ? { 81 ssl: Env.get('DB_CA_CERT') ? {
82 rejectUnauthorized: false, 82 rejectUnauthorized: false,
83 ca: Env.get('DB_CA_CERT'), 83 ca: Env.get('DB_CA_CERT'),
diff --git a/docker/README.md b/docker/README.md
index fa36da9..fd5debb 100644
--- a/docker/README.md
+++ b/docker/README.md
@@ -1,10 +1,10 @@
1# Ferdi-server-docker 1# Ferdium-server-docker
2[Ferdi](https://github.com/getferdi/ferdi) is a hard-fork of [Franz](https://github.com/meetfranz/franz), adding awesome features and removing unwanted ones. Ferdi-server is an unofficial replacement of the Franz server for use with the Ferdi Client. 2[Ferdium](https://github.com/ferdium/ferdium-app) is a hard-fork of [Ferdi](https://github.com/getferdi/ferdi), adding awesome features and removing unwanted ones. Ferdium-server is an unofficial replacement of the Franz/Ferdi server for use with the Ferdium Client.
3 3
4This is a dockerized version of [Ferdi-server](https://github.com/getferdi/server) running on Alpine Linux and Node.js (v10.16.3). 4This is a dockerized version of [Ferdium-server](https://github.com/ferdium/ferdium-server) running on Alpine Linux and Node.js (v10.16.3).
5 5
6## Why use a custom Ferdi-server? 6## Why use a custom Ferdium-server?
7A custom Ferdi-server allows you to experience the full potential of the Ferdi Client. It allows you to use all Premium features (e.g. Workspaces and custom URL recipes) and [add your own recipes](#creating-and-using-custom-recipes). 7A custom Ferdium-server allows you to experience the full potential of the Ferdium Client. It allows you to use all Premium features (e.g. Workspaces and custom URL recipes) for free and [add your own recipes](#creating-and-using-custom-recipes) that are monetized in Franz.
8 8
9## Features 9## Features
10- [x] User registration and login 10- [x] User registration and login
@@ -13,16 +13,16 @@ A custom Ferdi-server allows you to experience the full potential of the Ferdi C
13- [x] Functioning service store 13- [x] Functioning service store
14- [x] User dashboard 14- [x] User dashboard
15- [x] Password recovery 15- [x] Password recovery
16- [x] Export/import data to other Ferdi-servers 16- [x] Export/import data to other Ferdium-servers
17- [ ] Recipe update 17- [ ] Recipe update
18 18
19## Installation & Setup 19## Installation & Setup
20 20
21Here are some example snippets to help you get started creating a container. 21Here are some example snippets to help you get started creating a container.
22 22
23The docker can be run as is, with the default sqlite database, or you can modify your environment variables to use an external database (e.g. MySQL, MariaDB, Postgres, etc). After setting up the docker container you will need to create a reverse proxy to access Ferdi-server outside of your home network, using a webserver such as NGINX. 23The docker can be run as is, with the default sqlite database, or you can modify your environment variables to use an external database (e.g. MySQL, MariaDB, Postgres, etc). After setting up the docker container you will need to create a reverse proxy to access Ferdium-server outside of your home network, using a webserver such as NGINX.
24 24
25**Existing users, please note:** The latest updates to Ferdi-server and the Ferdi-server Docker image introduce changes to the default SQLite database name and location, as well as the internal container port. The new container port is `3333`. If you would like to keep your existing SQLite database, you will need to add the `DATA_DIR` variable and change it to `/app/database`, to match your existing data volume. You will also need to change the `DB_DATABASE` variable to `development` to match your existing database. Please see the parameters in the [Migration section](#migrating-from-an-existing-ferdi-server) below. 25**Existing users, please note:** The latest updates to Ferdium-server and the Ferdium-server Docker image, introduce changes to the default SQLite database name and location, as well as the internal container port. The new container port is `3333`. If you would like to keep your existing SQLite database, you will need to add the `DATA_DIR` variable and change it to `/app/database`, to match your existing data volume. You will also need to change the `DB_DATABASE` variable to `development` to match your existing database. Please see the parameters in the [Migration section](#migrating-from-an-existing-ferdium-server) below.
26 26
27### docker 27### docker
28 28
@@ -33,9 +33,9 @@ Pull the docker image:
33To create the docker container with the proper parameters: 33To create the docker container with the proper parameters:
34 34
35 docker create \ 35 docker create \
36 --name=ferdi-server \ 36 --name=ferdium-server \
37 -e NODE_ENV=development \ 37 -e NODE_ENV=development \
38 -e APP_URL=<ferdi-server-url> \ 38 -e APP_URL=<ferdium-server-url> \
39 -e DB_CONNECTION=<database> \ 39 -e DB_CONNECTION=<database> \
40 -e DB_HOST=<yourdbhost> \ 40 -e DB_HOST=<yourdbhost> \
41 -e DB_PORT=<yourdbport> \ 41 -e DB_PORT=<yourdbport> \
@@ -63,46 +63,46 @@ 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/getferdi/server/tree/master/docker/docker-compose.yml) if you are happy with the default environmental 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). 66You 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).
67 67
68 To start the application, use `docker-compose -f docker/docker-compose.yml up -d`. 68To start the application, use `docker-compose -f docker/docker-compose.yml up -d`.
69The server will be launched at [http://localhost:3333/](http://localhost:3333/) address. 69The server will be launched at [http://localhost:3333/](http://localhost:3333/) address.
70 70
71## Configuration 71## Configuration
72 72
73Container images are configured using parameters passed at runtime (such as those above). An explanaition of the default parameters is included below, but please see [the Docker documentation](https://docs.docker.com/get-started/overview/) for additional information. 73Container images are configured using parameters passed at runtime (such as those above). An explanaition of the default parameters is included below, but please see [the Docker documentation](https://docs.docker.com/get-started/overview/) for additional information.
74 74
75<strike>If any environmental parameter is not passed to the container, its value will be taken from the `/config/config.txt` file.</strike> 75<strike>If any environment parameter is not passed to the container, its value will be taken from the `/config/config.txt` file.</strike>
76**Warning, the use of `config.txt` is now deprecated. Please make sure to pass the correct environmental variables to your container at runtime. ** 76**Warning, the use of `config.txt` is now deprecated. Please make sure to pass the correct environment variables to your container at runtime. **
77 77
78| Parameter | Function | 78| Parameter | Function |
79| :----: | --- | 79| :----: | --- |
80| `-p <port>:3333` | Will map the container's port 3333 to a port on the host, default is 3333. See the [Docker docs](https://docs.docker.com/config/containers/container-networking/) for more information about port mapping | 80| `-p <port>:3333` | Will map the container's port 3333 to a port on the host, default is 3333. See the [Docker docs](https://docs.docker.com/config/containers/container-networking/) for more information about port mapping |
81| `-e NODE_ENV=development` | for specifying Node environment, production or development, default is development **currently this should not be changed**. See the [Docker docs](https://docs.docker.com/) for more information on the use of environmental variables in [Command-line](https://docs.docker.com/engine/reference/commandline/run/#mount-volume--v---read-only) and [Docker Compose](https://docs.docker.com/compose/environment-variables/) | 81| `-e NODE_ENV=development` | for specifying Node environment, production or development, default is development **currently this should not be changed**. See the [Docker docs](https://docs.docker.com/) for more information on the use of environment variables in [Command-line](https://docs.docker.com/engine/reference/commandline/run/#mount-volume--v---read-only) and [Docker Compose](https://docs.docker.com/compose/environment-variables/) |
82| `-e APP_URL=<ferdi-server-url>` | for specifying the URL of the Ferdi-server, including `http://` or `https://` as relevant. | 82| `-e APP_URL=<ferdium-server-url>` | for specifying the URL of the Ferdium-server, including `http://` or `https://` as relevant. |
83| `-e DB_CONNECTION=<databasedriver` | for specifying the database being used, default is sqlite, see [below](#supported-databases-and-drivers) for other options | 83| `-e DB_CONNECTION=<databasedriver` | for specifying the database being used, default is `sqlite`, see [below](#supported-databases-and-drivers) for other options |
84| `-e DB_HOST=<yourdbhost>` | for specifying the database host, default is 127.0.0.1 | 84| `-e DB_HOST=<yourdbhost>` | for specifying the database host, default is `127.0.0.1` |
85| `-e DB_PORT=<yourdbport>` | for specifying the database port, default is 3306 | 85| `-e DB_PORT=<yourdbport>` | for specifying the database port, default is `3306` |
86| `-e DB_USER=<yourdbuser>` | for specifying the database user, default is root | 86| `-e DB_USER=<yourdbuser>` | for specifying the database user, default is `root` |
87| `-e DB_PASSWORD=<yourdbpass>` | for specifying the database password, default is password | 87| `-e DB_PASSWORD=<yourdbpass>` | for specifying the database password, default is `password` |
88| `-e DB_DATABASE=<databasename>` | for specifying the database name to be used, default is ferdi | 88| `-e DB_DATABASE=<databasename>` | for specifying the database name to be used, default is `ferdium` |
89| `-e DB_SSL=false` | true only if your database is postgres and it is hosted online, on platforms like GCP, AWS, etc | 89| `-e DB_SSL=false` | true only if your database is postgres and it is hosted online, on platforms like GCP, AWS, etc |
90| `-e MAIL_CONNECTION=<mailsender>` | for specifying the mail sender to be used, default is smtp | 90| `-e MAIL_CONNECTION=<mailsender>` | for specifying the mail sender to be used, default is `smtp` |
91| `-e SMTP_HOST=<smtpmailserver>` | for specifying the mail host to be used, default is 127.0.0.1 | 91| `-e SMTP_HOST=<smtpmailserver>` | for specifying the mail host to be used, default is `127.0.0.1` |
92| `-e SMTP_PORT=<smtpport>` | for specifying the mail port to be used, default is 2525 | 92| `-e SMTP_PORT=<smtpport>` | for specifying the mail port to be used, default is `2525` |
93| `-e MAIL_SSL=true/false` | for specifying SMTP mail security, default is false | 93| `-e MAIL_SSL=true/false` | for specifying SMTP mail security, default is `false` |
94| `-e MAIL_USERNAME=<yourmailusername>` | for specifying your mail username to be used, default is username | 94| `-e MAIL_USERNAME=<yourmailusername>` | for specifying your mail username to be used, default is `username` |
95| `-e MAIL_PASSWORD=<yourmailpassword>` | for specifying your mail password to be used, default is password | 95| `-e MAIL_PASSWORD=<yourmailpassword>` | for specifying your mail password to be used, default is `password` |
96| `-e MAIL_SENDER=<sendemailaddress` | for specifying the mail sender address to be used, default is noreply@getferdi.com | 96| `-e MAIL_SENDER=<sendemailaddress` | for specifying the mail sender address to be used, default is `noreply@ferdium.org` |
97| `-e IS_CREATION_ENABLED=true` | for specifying whether to enable the [creation of custom recipes](#creating-and-using-custom-recipes), default is true | 97| `-e IS_CREATION_ENABLED=true` | for specifying whether to enable the [creation of custom recipes](#creating-and-using-custom-recipes), default is `true` |
98| `-e IS_DASHBOARD_ENABLED=true` | for specifying whether to enable the Ferdi-server dashboard, default is true | 98| `-e IS_DASHBOARD_ENABLED=true` | for specifying whether to enable the Ferdium-server dashboard, default is `true` |
99| `-e IS_REGISTRATION_ENABLED=true` | for specifying whether to allow user registration, default is true | 99| `-e IS_REGISTRATION_ENABLED=true` | for specifying whether to allow user registration, default is `true` |
100| `-e CONNECT_WITH_FRANZ=true` | for specifying whether to enable connections to the Franz server, default is true | 100| `-e CONNECT_WITH_FRANZ=true` | for specifying whether to enable connections to the Franz server, default is `true` |
101| `-e DATA_DIR=/data` | for specifying the SQLite database folder, default is /data | 101| `-e DATA_DIR=/data` | for specifying the SQLite database folder, default is `/data` |
102| `-v <path to data on host>:/data` | this will store Ferdi-server's data (its database, among other things) on the docker host for persistence. See the [Docker docs](https://docs.docker.com/storage/volumes/) for more information on the use of container volumes | 102| `-v <path to data on host>:/data` | this will store Ferdium-server's data (its database, among other things) on the docker host for persistence. See the [Docker docs](https://docs.docker.com/storage/volumes/) for more information on the use of container volumes |
103| `-v <path to recipes on host>:/app/recipes` | this will store Ferdi-server's recipes on the docker host for persistence | 103| `-v <path to recipes on host>:/app/recipes` | this will store Ferdium-server's recipes on the docker host for persistence |
104 104
105By enabling the `CONNECT_WITH_FRANZ` option, Ferdi-server can: 105By enabling the `CONNECT_WITH_FRANZ` option, Ferdium-server can:
106 - Show the full Franz recipe library instead of only custom recipes 106 - Show the full Franz recipe library instead of only custom recipes
107 - Import Franz accounts 107 - Import Franz accounts
108 108
@@ -127,45 +127,45 @@ To use a different email sender than the default, SMTP, enter the correct inform
127| Mailgun | MAILGUN_DOMAIN, MAILGUN_API_REGION, MAILGUN_API_KEY | 127| Mailgun | MAILGUN_DOMAIN, MAILGUN_API_REGION, MAILGUN_API_KEY |
128| (**Deprecated**) Ethereal | A disposable account is created automatically if you choose this option. | 128| (**Deprecated**) Ethereal | A disposable account is created automatically if you choose this option. |
129 129
130## Migrating from an existing Ferdi-server 130## Migrating from an existing Ferdium-server
131 131
132If you are an existing Ferdi-server user using the built-in `SQlite` database, you should include the following variables: 132If you are an existing Ferdium-server user using the built-in `SQlite` database, you should include the following variables:
133| Parameter | Function | 133| Parameter | Function |
134| :----: | --- | 134| :----: | --- |
135| `-p 3333:3333` | existing Ferdi-server users will need to update their container port mappings from `80:3333` to `3333:3333` | 135| `-p 3333:3333` | existing Ferdium-server users will need to update their container port mappings from `80:3333` to `3333:3333` |
136| `-e DB_PASSWORD=development` | existing Ferdi-server users who use the built-in sqlite database should use the database name `development` | 136| `-e DB_PASSWORD=development` | existing Ferdium-server users who use the built-in sqlite database should use the database name `development` |
137| `-e DATA_DIR=/app/database` | existing Ferdi-server users who use the built-in sqlite database should add this environmental variable to ensure data persistence | 137| `-e DATA_DIR=/app/database` | existing Ferdium-server users who use the built-in sqlite database should add this environment variable to ensure data persistence |
138| `-v <path to data on host>=/app/databases` | existing Ferdi-server users who use the built-in sqlite database should use the volume name `/app/database` | 138| `-v <path to data on host>=/app/databases` | existing Ferdium-server users who use the built-in sqlite database should use the volume name `/app/database` |
139 139
140If you are an existing Ferdi-server user who uses an external database or different variables for the built-in `SQlite` database, you should updatae your parameterse acordingly. For example, if you aree using an exterenal MariaDB or MySql database your unique parameters might look like this: 140If you are an existing Ferdium-server user who uses an external database or different variables for the built-in `SQlite` database, you should updatae your parameterse acordingly. For example, if you aree using an exterenal MariaDB or MySql database your unique parameters might look like this:
141| Parameter | Function | 141| Parameter | Function |
142| :----: | --- | 142| :----: | --- |
143| `-e DB_CONNECTION=mysql` | for specifying the database being used | 143| `-e DB_CONNECTION=mysql` | for specifying the database being used |
144| `-e DB_HOST=192.168.10.1` | for specifying the database host machine IP | 144| `-e DB_HOST=192.168.10.1` | for specifying the database host machine IP |
145| `-e DB_PORT=3306` | for specifying the database port | 145| `-e DB_PORT=3306` | for specifying the database port |
146| `-e DB_USER=ferdi` | for specifying the database user | 146| `-e DB_USER=ferdium` | for specifying the database user |
147| `-e DB_PASSWORD=ferdipw` | for specifying the database password| 147| `-e DB_PASSWORD=ferdiumpw` | for specifying the database password|
148| `-e DB_DATABASE=adonis` | for specifying the database to be used| 148| `-e DB_DATABASE=adonis` | for specifying the database to be used|
149| `-v <path to database>:/app/database` | this will strore Ferdi-server's database on the docker host for persistence | 149| `-v <path to database>:/app/database` | this will store Ferdium-server's database on the docker host for persistence |
150| `-v <path to recipes>:/app/recipes` | this will strore Ferdi-server's recipes on the docker host for persistence | 150| `-v <path to recipes>:/app/recipes` | this will store Ferdium-server's recipes on the docker host for persistence |
151 151
152**In either case, please be sure to pass the correct variables to the new Ferdi-server container in order maintain access to your existing database.** 152**In either case, please be sure to pass the correct variables to the new Ferdium-server container in order maintain access to your existing database.**
153 153
154## NGINX config block 154## NGINX config block
155 155
156To access Ferdi-server from outside of your home network on a subdomain use this server block: 156To access Ferdium-server from outside of your home network on a subdomain use this server block:
157 157
158``` 158```
159# Ferdi-server 159# Ferdium-server
160server { 160server {
161 listen 443 ssl http2; 161 listen 443 ssl http2;
162 server_name ferdi.my.website; 162 server_name ferdium.my.website;
163 163
164 # all ssl related config moved to ssl.conf 164 # all ssl related config moved to ssl.conf
165 include /config/nginx/ssl.conf; 165 include /config/nginx/ssl.conf;
166 166
167 location / { 167 location / {
168 proxy_pass http://<Ferdi-IP>:3333; 168 proxy_pass http://<Ferdium-IP>:3333;
169 proxy_set_header X-Real-IP $remote_addr; 169 proxy_set_header X-Real-IP $remote_addr;
170 proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; 170 proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
171 proxy_set_header Host $host; 171 proxy_set_header Host $host;
@@ -174,11 +174,11 @@ server {
174} 174}
175``` 175```
176 176
177## Importing your Franz account 177## Importing your Franz/Ferdi account
178 178
179Ferdi-server allows you to import your full Franz account, including all its settings. 179Ferdium-server allows you to import your full Franz account, including all its settings.
180 180
181To 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. 181To import your Franz account, open `http://[YOUR FERDIUM-SERVER]/import` in your browser and login using your Franz account details. Ferdium-server will create a new user with the same credentials and copy your Franz settings, services and workspaces.
182 182
183## Transferring user data 183## Transferring user data
184 184
@@ -186,48 +186,48 @@ Please refer to <https://github.com/getferdi/ferdi/wiki/Transferring-data-betwee
186 186
187## Creating and using custom recipes 187## Creating and using custom recipes
188 188
189Ferdi-server allows to extends the Franz recipe catalogue with custom Ferdi recipes. 189Ferdium-server allows to extends the Franz recipe catalogue with custom Ferdi recipes.
190 190
191For documentation on how to create a recipe, please visit [the official guide by Franz](https://github.com/meetfranz/plugins/blob/master/docs/integration.md). 191For documentation on how to create a recipe, please visit [the official guide](https://github.com/ferdium/ferdium-recipes/blob/master/docs/integration.md).
192 192
193To add your recipe to Ferdi-server, open `http://[YOUR FERDI-SERVER]/new` in your browser. You can now define the following settings: 193To 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 [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. 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.
199 199
200### Listing custom recipes 200### Listing custom recipes
201 201
202Inside Ferdi, searching for `ferdi:custom` will list all your custom recipes. 202Inside Ferdium, searching for `ferdium:custom` will list all your custom recipes.
203 203
204## Support Info 204## Support Info
205 205
206* Shell access while the container is running: `docker exec -it ferdi-server /bin/bash` 206* Shell access while the container is running: `docker exec -it ferdium-server /bin/bash`
207* To monitor the logs of the container in realtime: `docker logs -f ferdi-server` 207* To monitor the logs of the container in realtime: `docker logs -f ferdium-server`
208 208
209## Updating Info 209## Updating Info
210 210
211Below are the instructions for updating the container to get the most recent version of Ferdi-server: 211Below are the instructions for updating the container to get the most recent version of Ferdium-server:
212 212
213### Via Docker Run/Create 213### Via Docker Run/Create
214 214
215* Update the image: `docker pull ghcr.io/ferdium/ferdium-server` 215* Update the image: `docker pull ghcr.io/ferdium/ferdium-server`
216* Stop the running container: `docker stop ferdi-server` 216* Stop the running container: `docker stop ferdium-server`
217* Delete the container: `docker rm ferdi-server` 217* Delete the container: `docker rm ferdium-server`
218* Recreate a new container with the same docker create parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and ENV settings will be preserved) 218* Recreate a new container with the same docker create parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and ENV settings will be preserved)
219* Start the new container: `docker start ferdi-server` 219* Start the new container: `docker start ferdium-server`
220 220
221### Via Docker Compose 221### Via Docker Compose
222 222
223* Update all images: `docker-compose -f docker/docker-compose.yml pull` 223* Update all images: `docker-compose -f docker/docker-compose.yml pull`
224 * or update a single image: `docker-compose -f docker/docker-compose.yml pull ferdi-server` 224 * or update a single image: `docker-compose -f docker/docker-compose.yml pull ferdium-server`
225* Let compose update all containers as necessary: `docker-compose -f docker/docker-compose.yml up -d` 225* Let compose update all containers as necessary: `docker-compose -f docker/docker-compose.yml up -d`
226 * or update a single container: `docker-compose -f docker/docker-compose.yml up -d ferdi-server` 226 * or update a single container: `docker-compose -f docker/docker-compose.yml up -d ferdium-server`
227 227
228## Building locally 228## Building locally
229 229
230If you want to build this image locally, please run this command from root of [Ferdi-server repository](https://github.com/getferdi/server/tree/master/): 230If 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/):
231``` 231```
232docker build \ 232docker build \
233 --no-cache \ 233 --no-cache \
@@ -236,4 +236,4 @@ docker build \
236``` 236```
237 237
238## License 238## License
239Ferdi-server-docker and Ferdi-server are licensed under the MIT License. 239Ferdium-server-docker and Ferdium-server are licensed under the MIT License.
diff --git a/docker/docker-compose.yml b/docker/docker-compose.yml
index 5a46cda..757717a 100644
--- a/docker/docker-compose.yml
+++ b/docker/docker-compose.yml
@@ -1,8 +1,8 @@
1version: "2" 1version: "2"
2services: 2services:
3 ferdi-server: 3 ferdium-server:
4 image: ghcr.io/ferdium/ferdium-server 4 image: ghcr.io/ferdium/ferdium-server
5 container_name: ferdi-server 5 container_name: ferdium-server
6 environment: 6 environment:
7 - NODE_ENV=development 7 - NODE_ENV=development
8 - APP_URL=localhost 8 - APP_URL=localhost
@@ -11,7 +11,7 @@ services:
11 - DB_PORT=3306 11 - DB_PORT=3306
12 - DB_USER=root 12 - DB_USER=root
13 - DB_PASSWORD=password 13 - DB_PASSWORD=password
14 - DB_DATABASE=ferdi 14 - DB_DATABASE=ferdium
15 - DB_SSL=false 15 - DB_SSL=false
16 - MAIL_CONNECTION=smtp 16 - MAIL_CONNECTION=smtp
17 - SMTP_HOST=127.0.0.1 17 - SMTP_HOST=127.0.0.1
@@ -19,7 +19,7 @@ services:
19 - MAIL_SSL=false 19 - MAIL_SSL=false
20 - MAIL_USERNAME=username 20 - MAIL_USERNAME=username
21 - MAIL_PASSWORD=password 21 - MAIL_PASSWORD=password
22 - MAIL_SENDER=noreply@getferdi.com 22 - MAIL_SENDER=noreply@ferdium.org
23 - IS_CREATION_ENABLED=true 23 - IS_CREATION_ENABLED=true
24 - IS_DASHBOARD_ENABLED=true 24 - IS_DASHBOARD_ENABLED=true
25 - IS_REGISTRATION_ENABLED=true 25 - IS_REGISTRATION_ENABLED=true
@@ -28,11 +28,11 @@ services:
28 - PUID=1000 28 - PUID=1000
29 - PGID=1000 29 - PGID=1000
30 volumes: 30 volumes:
31 - ferdi-database-vol:/data 31 - ferdium-database-vol:/data
32 - ferdi-recipes-vol:/app/recipes 32 - ferdium-recipes-vol:/app/recipes
33 ports: 33 ports:
34 - 3333:3333 34 - 3333:3333
35 restart: unless-stopped 35 restart: unless-stopped
36volumes: 36volumes:
37 ferdi-database-vol: 37 ferdium-database-vol:
38 ferdi-recipes-vol: 38 ferdium-recipes-vol:
diff --git a/docker/entrypoint.sh b/docker/entrypoint.sh
index 2e58abc..44f480f 100755
--- a/docker/entrypoint.sh
+++ b/docker/entrypoint.sh
@@ -2,19 +2,21 @@
2 2
3cat << EOL 3cat << EOL
4------------------------------------- 4-------------------------------------
5 ____ ___ 5 ______ ___
6 / __/__ _______/ (_) 6 / ____/__ _________/ (_)_ ______ ___
7 / _// -_) __/ _ / / 7 / /_ / _ \/ ___/ __ / / / / / __ `__ \
8 _/_/ \__/_/ \_,_/_/ 8 / __/ / __/ / / /_/ / / /_/ / / / / / /
9 / __/__ _____ _____ ____ 9 /_/ \___/_/ \__,_/_/\__,_/_/ /_/ /_/
10 _\ \/ -_) __/ |/ / -_) __/ 10
11 /___/\__/_/ |___/\__/_/ 11 _____
12Brought to you by getferdi.com 12 / ___/___ ______ _____ _____
13Support our Open Collective at: 13 \__ \/ _ \/ ___/ | / / _ \/ ___/
14https://opencollective.com/getferdi/ 14 ___/ / __/ / | |/ / __/ /
15 /____/\___/_/ |___/\___/_/
16Brought to you by ferdium.org
15EOL 17EOL
16 18
17key_file="${DATA_DIR}/FERDI_APP_KEY.txt" 19key_file="${DATA_DIR}/FERDIUM_APP_KEY.txt"
18 20
19print_app_key_message() { 21print_app_key_message() {
20 app_key=$1 22 app_key=$1
@@ -25,7 +27,7 @@ print_app_key_message() {
25# Create APP key if needed 27# Create APP key if needed
26if [ -z ${APP_KEY} ] && [ ! -f ${key_file} ] 28if [ -z ${APP_KEY} ] && [ ! -f ${key_file} ]
27then 29then
28 echo '**** Generating Ferdi-server app key for first run ****' 30 echo '**** Generating Ferdium-server app key for first run ****'
29 adonis key:generate 31 adonis key:generate
30 APP_KEY=$(grep APP_KEY .env | cut -d '=' -f2) 32 APP_KEY=$(grep APP_KEY .env | cut -d '=' -f2)
31 echo ${APP_KEY} > ${key_file} 33 echo ${APP_KEY} > ${key_file}
diff --git a/package-lock.json b/package-lock.json
index 1850bcd..b83c091 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -1,5 +1,5 @@
1{ 1{
2 "name": "ferdi-server", 2 "name": "ferdium-server",
3 "version": "1.3.2", 3 "version": "1.3.2",
4 "lockfileVersion": 1, 4 "lockfileVersion": 1,
5 "requires": true, 5 "requires": true,
diff --git a/package.json b/package.json
index 351b248..40d7e2f 100644
--- a/package.json
+++ b/package.json
@@ -1,8 +1,8 @@
1{ 1{
2 "name": "ferdi-server", 2 "name": "ferdium-server",
3 "version": "1.3.2", 3 "version": "1.3.2",
4 "adonis-version": "4.1.0", 4 "adonis-version": "4.1.0",
5 "description": "Ferdi server to replace the default Franz server.", 5 "description": "Ferdium server to replace the default Franz/Ferdi server.",
6 "main": "index.js", 6 "main": "index.js",
7 "engines": { 7 "engines": {
8 "node": "^14.17", 8 "node": "^14.17",
diff --git a/resources/announcements/version.json b/resources/announcements/version.json
index 79aabf3..3865a89 100644
--- a/resources/announcements/version.json
+++ b/resources/announcements/version.json
@@ -1,10 +1,10 @@
1{ 1{
2 "main": { 2 "main": {
3 "headline": "Example Accouncement", 3 "headline": "Example Announcement",
4 "subHeadline": "Configure your announcement here", 4 "subHeadline": "Configure your announcement here",
5 "image": { 5 "image": {
6 "light": "https://api.getferdi.com/assets/feature/light.png", 6 "light": "https://api.ferdium.org/assets/feature/light.png",
7 "dark": "https://api.getferdi.com/assets/feature/dark.png" 7 "dark": "https://api.ferdium.org/assets/feature/dark.png"
8 }, 8 },
9 "text": "Long description here", 9 "text": "Long description here",
10 "cta": { 10 "cta": {
@@ -31,4 +31,4 @@
31 } 31 }
32 } 32 }
33 } 33 }
34} \ No newline at end of file 34}
diff --git a/resources/views/dashboard/account.edge b/resources/views/dashboard/account.edge
index a36d175..b805ac5 100644
--- a/resources/views/dashboard/account.edge
+++ b/resources/views/dashboard/account.edge
@@ -4,7 +4,7 @@
4<div class="w-screen bg-purple-200 flex items-center justify-center"> 4<div class="w-screen bg-purple-200 flex items-center justify-center">
5 <div class="w-full max-w-lg bg-white shadow-md rounded px-8 pt-6 pb-8 mb-4"> 5 <div class="w-full max-w-lg bg-white shadow-md rounded px-8 pt-6 pb-8 mb-4">
6 <h1 class="text-gray-700 text-center text-2xl pb-5"> 6 <h1 class="text-gray-700 text-center text-2xl pb-5">
7 Your Ferdi account 7 Your Ferdium account
8 </h1> 8 </h1>
9 @if(flashMessage('error')) 9 @if(flashMessage('error'))
10 <div class="bg-orange-100 border-l-4 border-orange-500 text-orange-700 p-4"> 10 <div class="bg-orange-100 border-l-4 border-orange-500 text-orange-700 p-4">
diff --git a/resources/views/dashboard/delete.edge b/resources/views/dashboard/delete.edge
index 1395f7a..d058a73 100644
--- a/resources/views/dashboard/delete.edge
+++ b/resources/views/dashboard/delete.edge
@@ -16,7 +16,7 @@
16 @endif 16 @endif
17 17
18 <form action="/user/delete" method="POST"> 18 <form action="/user/delete" method="POST">
19 <p>Are you sure, that you want to delete your Ferdi account?</p> 19 <p>Are you sure, that you want to delete your Ferdium account?</p>
20 <p>This will <b>permanently</b> delete all your account settings, services and workspaces.</p> 20 <p>This will <b>permanently</b> delete all your account settings, services and workspaces.</p>
21 <div class="pt-8"> 21 <div class="pt-8">
22 {{ csrfField() }} 22 {{ csrfField() }}
diff --git a/resources/views/dashboard/login.edge b/resources/views/dashboard/login.edge
index ee354a4..23995ae 100644
--- a/resources/views/dashboard/login.edge
+++ b/resources/views/dashboard/login.edge
@@ -61,7 +61,7 @@
61 </div> 61 </div>
62 <div class="text-center"> 62 <div class="text-center">
63 <a class="w-full font-bold text-sm text-blue-500 hover:text-blue-800" href="../import"> 63 <a class="w-full font-bold text-sm text-blue-500 hover:text-blue-800" href="../import">
64 Import your Franz account 64 Import your Franz/Ferdi account
65 </a> 65 </a>
66 </div> 66 </div>
67</form> 67</form>
diff --git a/resources/views/dashboard/transfer.edge b/resources/views/dashboard/transfer.edge
index 9412a8c..103381d 100644
--- a/resources/views/dashboard/transfer.edge
+++ b/resources/views/dashboard/transfer.edge
@@ -28,7 +28,7 @@
28 <h3 class="text-gray-600 text-xl">Import data</h3> 28 <h3 class="text-gray-600 text-xl">Import data</h3>
29 <div> 29 <div>
30 <div> 30 <div>
31 <input type="file" name="file" id="file" value="" accept=".json,.ferdi-data" required> 31 <input type="file" name="file" id="file" value="" accept=".json,.ferdi-data,.ferdium-data" required>
32 </div> 32 </div>
33 </div> 33 </div>
34 34
diff --git a/resources/views/layouts/main.edge b/resources/views/layouts/main.edge
index 00d9987..c611bc5 100644
--- a/resources/views/layouts/main.edge
+++ b/resources/views/layouts/main.edge
@@ -5,7 +5,7 @@
5 <meta charset="UTF-8"> 5 <meta charset="UTF-8">
6 <meta name="viewport" content="width=device-width, initial-scale=1.0"> 6 <meta name="viewport" content="width=device-width, initial-scale=1.0">
7 <meta http-equiv="X-UA-Compatible" content="ie=edge"> 7 <meta http-equiv="X-UA-Compatible" content="ie=edge">
8 <title>ferdi-server</title> 8 <title>ferdium-server</title>
9 <link rel="shortcut icon" type="image/jpg" href="img/favicon.ico" /> 9 <link rel="shortcut icon" type="image/jpg" href="img/favicon.ico" />
10 10
11 {{ style('css/vanilla') }} 11 {{ style('css/vanilla') }}
diff --git a/resources/views/layouts/v2.edge b/resources/views/layouts/v2.edge
index 999be94..312ed67 100644
--- a/resources/views/layouts/v2.edge
+++ b/resources/views/layouts/v2.edge
@@ -16,8 +16,8 @@
16 <div class="flex flex-col h-screen"> 16 <div class="flex flex-col h-screen">
17 <div class="bg-black"> 17 <div class="bg-black">
18 <div class="flex flex-row items-center container px-20 mx-auto"> 18 <div class="flex flex-row items-center container px-20 mx-auto">
19 <a href="/"><img width="50" class="my-4 mr-10" src="https://github.com/getferdi/server/raw/master/logo.png"></a> 19 <a href="/"><img width="50" class="my-4 mr-10" src="https://github.com/ferdium/ferdium-server/raw/master/logo.png"></a>
20 <a class="github-button" href="https://github.com/getferdi/server" data-icon="octicon-star" data-show-count="true" aria-label="Star getferdi/server on GitHub">Star</a> 20 <a class="github-button" href="https://github.com/ferdium/ferdium-server" data-icon="octicon-star" data-show-count="true" aria-label="Star ferdium/ferdium-server on GitHub">Star</a>
21 </div> 21 </div>
22 </div> 22 </div>
23 <div class="flex flex-1"> 23 <div class="flex flex-1">
diff --git a/resources/views/others/import.edge b/resources/views/others/import.edge
index 918c60b..7fb58de 100644
--- a/resources/views/others/import.edge
+++ b/resources/views/others/import.edge
@@ -5,10 +5,10 @@
5<form class="w-full max-w-sm bg-white shadow-md rounded px-8 pt-6 pb-8 mb-4" 5<form class="w-full max-w-sm bg-white shadow-md rounded px-8 pt-6 pb-8 mb-4"
6 action="/import" method="POST"> 6 action="/import" method="POST">
7 <h1 class="text-gray-700 text-center text-2xl pb-5"> 7 <h1 class="text-gray-700 text-center text-2xl pb-5">
8 Import your Franz account 8 Import your Franz/Ferdi account
9 </h1> 9 </h1>
10 <p class="text-gray-600 text-sm text-center py-2"> 10 <p class="text-gray-600 text-sm text-center py-2">
11 Please login using your Franz account. We will create a new Ferdi account with the same credentials. 11 Please login using your Franz/Ferdi account. We will create a new Ferdium account with the same credentials.
12 </p> 12 </p>
13 13
14 @if(flashMessage('error')) 14 @if(flashMessage('error'))
@@ -54,7 +54,7 @@
54 Import account 54 Import account
55 </button> 55 </button>
56 <p class="text-gray-600 text-sm text-center py-2"> 56 <p class="text-gray-600 text-sm text-center py-2">
57 By importing your Franz account, you accept the <a href="/terms">terms of service</a> and <a href="/privacy">privacy 57 By importing your Franz/Ferdi account, you accept the <a href="/terms">terms of service</a> and <a href="/privacy">privacy
58 policy</a> 58 policy</a>
59 </p> 59 </p>
60 <div class="text-center"> 60 <div class="text-center">
diff --git a/resources/views/others/index.edge b/resources/views/others/index.edge
index ade5304..5cc5726 100644
--- a/resources/views/others/index.edge
+++ b/resources/views/others/index.edge
@@ -17,7 +17,7 @@
17 <div class="flex w-full justify-center md:justify-start pb-0 fade-in"> 17 <div class="flex w-full justify-center md:justify-start pb-0 fade-in">
18 <ol class="list-decimal list-inside"> 18 <ol class="list-decimal list-inside">
19 <li> 19 <li>
20 Logout of Ferdi, if you are currently logged in 20 Logout of Ferdium, if you are currently logged in
21 </li> 21 </li>
22 <li> 22 <li>
23 Choose "Change Server" to get to the settings screen 23 Choose "Change Server" to get to the settings screen
@@ -34,7 +34,7 @@
34 <a href="/user/account" class="bg-gray-700 hover:bg-gray-900 text-white font-bold text-center md:text-left py-2 px-4 rounded"> 34 <a href="/user/account" class="bg-gray-700 hover:bg-gray-900 text-white font-bold text-center md:text-left py-2 px-4 rounded">
35 Go to account dashboard 35 Go to account dashboard
36 </a> 36 </a>
37 <p class="text-gray-700 my-10 py-0 pb-8 lg:pb-6 text-center md:text-left fade-in pt-2"><em><a href="https://getferdi.com">Don't have Ferdi yet?</a></em></p> 37 <p class="text-gray-700 my-10 py-0 pb-8 lg:pb-6 text-center md:text-left fade-in pt-2"><em><a href="https://ferdium.org">Don't have Ferdium yet?</a></em></p>
38 </div> 38 </div>
39 39
40 <!--Right Col--> 40 <!--Right Col-->
diff --git a/resources/views/others/new.edge b/resources/views/others/new.edge
index 96bd0ee..1bfd46f 100644
--- a/resources/views/others/new.edge
+++ b/resources/views/others/new.edge
@@ -2,8 +2,8 @@
2 2
3@section('content') 3@section('content')
4<h1>Create a new recipe</h1> 4<h1>Create a new recipe</h1>
5<p>Please create a recipe using <a href="https://github.com/meetfranz/plugins/blob/master/docs/integration.md">the 5<p>Please create a recipe using <a href="https://github.com/ferdium/ferdium-recipes/blob/master/docs/integration.md">the
6 official Franz guide</a>, then publish it here.</p> 6 official guide</a>, then publish it here.</p>
7<form action="new" method="post" enctype="multipart/form-data"> 7<form action="new" method="post" enctype="multipart/form-data">
8 <label for="author">Author</label><br /> 8 <label for="author">Author</label><br />
9 <input type="text" name="author" placeholder="Jon Doe" required><br /> 9 <input type="text" name="author" placeholder="Jon Doe" required><br />
diff --git a/start/events.js b/start/events.js
index 481ad98..a99afd5 100644
--- a/start/events.js
+++ b/start/events.js
@@ -5,7 +5,7 @@ const Env = use('Env');
5Event.on('forgot::password', async ({ user, token }) => { 5Event.on('forgot::password', async ({ user, token }) => {
6 const body = ` 6 const body = `
7Hello ${user.username}, 7Hello ${user.username},
8we received a request to reset your Ferdi account password. 8we received a request to reset your Ferdium account password.
9Use the link below to reset your password. If you didn't requested that your password be reset, please ignore this message. 9Use the link below to reset your password. If you didn't requested that your password be reset, please ignore this message.
10 10
11${Env.get('APP_URL')}/user/reset?token=${encodeURIComponent(token)} 11${Env.get('APP_URL')}/user/reset?token=${encodeURIComponent(token)}
@@ -15,7 +15,7 @@ This message was sent automatically. Please do not reply.
15 console.log('Sending message', body); 15 console.log('Sending message', body);
16 try { 16 try {
17 await Mail.raw(body, (message) => { 17 await Mail.raw(body, (message) => {
18 message.subject('[Ferdi] Reset your password'); 18 message.subject('[Ferdium] Reset your password');
19 message.from(Env.get('MAIL_SENDER')); 19 message.from(Env.get('MAIL_SENDER'));
20 message.to(user.email); 20 message.to(user.email);
21 }); 21 });
diff --git a/start/routes.js b/start/routes.js
index f269dc8..64a7605 100644
--- a/start/routes.js
+++ b/start/routes.js
@@ -114,7 +114,7 @@ Route.get('new', ({ response, view }) => {
114 return view.render('others.new'); 114 return view.render('others.new');
115}); 115});
116 116
117// Franz account import 117// Franz/Ferdi account import
118Route.post('import', 'UserController.import'); 118Route.post('import', 'UserController.import');
119Route.get('import', ({ view }) => view.render('others.import')); 119Route.get('import', ({ view }) => view.render('others.import'));
120 120