Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ferdium/ferdium-server

The server component that can either be self-hosted or hosted for general purpose - for use with the ferdium thick client.
https://github.com/ferdium/ferdium-server

hacktoberfest hacktoberfest-accepted

Last synced: 6 days ago
JSON representation

The server component that can either be self-hosted or hosted for general purpose - for use with the ferdium thick client.

Host: GitHub
URL: https://github.com/ferdium/ferdium-server
Owner: ferdium
License: mit
Created: 2022-04-14T01:58:16.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2024-04-20T20:38:53.000Z (7 months ago)
Last Synced: 2024-04-22T12:25:10.849Z (7 months ago)
Topics: hacktoberfest, hacktoberfest-accepted
Language: TypeScript
Homepage:
Size: 2.57 MB
Stars: 148
Watchers: 3
Forks: 39
Open Issues: 17
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

# Server
[![Docker Build and Publish](https://github.com/ferdium/ferdium-server/actions/workflows/docker.yml/badge.svg)](https://github.com/ferdium/ferdium-server/actions/workflows/docker.yml)

> 👨🏾‍🍳 Server for [Ferdium](https://ferdium.org) that you can re-use to run your own

## Why use a custom server?

_Find answers to other frequently asked questions on [ferdium.org/faq](https://ferdium.org/faq)._

Toggle answer

A custom server allows you to manage the data of all registered users yourself and add your own recipes to the repository. If you are not interested in doing this you can use our official instance of the server at [api.ferdium.org](https://api.ferdium.org).

## Features
- [x] User registration and login
- [x] Service creation, download, listing and removing
- [x] Workspace support
- [x] Functioning service store
- [x] User dashboard
- [x] Export/import data to other Ferdium-servers
- [x] Password recovery
- [x] Recipe update

## Deploying the App

Setup with Docker
The easiest way to set up Ferdium-server on your server is with Docker.

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).
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.

**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.

1. Pull the Docker image

```sh
docker pull ferdium/ferdium-server:latest
```
2. Create a *new* Docker container with your desired configuration **Existing users please seee the warning above.**

```sh
docker create \
--name=ferdium-server \
-e NODE_ENV=development \
-e APP_URL= \
-e DB_CONNECTION= \
-e DB_HOST= \
-e DB_PORT= \
-e DB_USER= \
-e DB_PASSWORD= \
-e DB_DATABASE= \
-e DB_SSL=false \
-e MAIL_CONNECTION=smtp \
-e SMTP_HOST= \
-e SMTP_PORT= \
-e MAIL_SSL=true/false \
-e MAIL_USERNAME= \
-e MAIL_PASSWORD= \
-e MAIL_SENDER= \
-e IS_CREATION_ENABLED=true \
-e IS_DASHBOARD_ENABLED=true \
-e IS_REGISTRATION_ENABLED=true \
-e CONNECT_WITH_FRANZ=true \
-e DATA_DIR=data \
-p :3333 \
-v :/data \
-v :/app/recipes \
--restart unless-stopped \
ferdium/ferdium-server:latest
```

Alternatively, you can also use docker-compose v2 schema. An example can be found [in the docker folder](./docker/docker-compose.yml).

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).

For more information on configuring the Docker image, please read [the Ferdium docker documentation](./docker/README.md).

Manual setup

1. Clone repository with submodule
2. Install the [AdonisJS CLI](https://adonisjs.com/)
3. Copy `.env.example` to `.env` and edit the [configuration](#configuration) to your needs
4. Have env DB_SSL=true only if your database is postgres and it is hosted online on platforms like GCP, AWS, etc
5. Run `npm install` to install local dependencies
6. Run the database migrations with

```js
node ace migration:run
```

7. Start the server with

```js
npm start
```

Configuration

Ferdium-server's configuration is saved inside an `.env` file. Besides AdonisJS's settings, Ferdium-server has the following custom settings:
- `IS_CREATION_ENABLED` (`true` or `false`, default: `true`): Whether to enable the [creation of custom recipes](#creating-and-using-custom-recipes)
- `IS_REGISTRATION_ENABLED` (`true` or `false`, default: `true`): Whether to enable the creation of new user accounts
- `IS_DASHBOARD_ENABLED` (`true` or `false`, default: `true`): Whether to enable the user dashboard
- `CONNECT_WITH_FRANZ` (`true` or `false`, default: `true`): Whether to enable connections to the Franz server. By enabling this option, Ferdium-server can:
- Show the full Franz recipe library instead of only custom recipes
- Import Franz accounts

Importing your Franz/Ferdi account

Ferdium-server allows you to import your full Franz/Ferdi account, including all its settings.

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.

Transferring user data

Please refer to

Creating and using custom recipes
Ferdium-server allows to extends the Franz/Ferdi recipe catalogue with custom Ferdium recipes.

For documentation on how to create a recipe, please visit [the official guide](https://github.com/ferdium/ferdium-recipes/blob/main/docs/integration.md).

To add your recipe to Ferdium-server, open `http://[YOUR FERDIUM-SERVER]/new` in your browser. You can now define the following settings:

- `Author`: Author who created the recipe
- `Name`: Name for your new service. Can contain spaces and unicode characters
- `Service ID`: Unique ID for this recipe. Does not contain spaces or special characters (e.g. `google-drive`)
- `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
- `Recipe files`: Recipe files that you created using the [recipe creation guide](https://github.com/ferdium/ferdium-recipes/blob/main/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.

Listing custom recipes

Inside Ferdium, searching for `ferdium:custom` will list all of your custom recipes.

## Contributing

Please read the [contributing guidelines](CONTRIBUTING.md) to setup your development machine and proceed.

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):