Configuration

First of all, go to https://your.url/config. You'll be prompt to enter some info.

Establish a database connection

Choose one of these DBMS:

SQLite

---

SQLite is the recommended DBMS for tests and prototyping. This is not suited for production environments. If you choose SQLite, everything is handled automatically. You have nothing to do except clicking "Connect".

---

PostgreSQL

---

This is the recommended DBMS.

1. To start a PostgreSQL server, follow these steps: https://www.postgresql.org/download/.

   However, if you are used to Docker, you can instead run this docker-compose.yml

2. Fill the configuration form with these info:

   • host: URL where your database is (eg. localhost, localhost:5432 or my.website.com)
   • database: the name of the database (eg. cloudsh)
   • user: your database username
   • password: your database password

---

Enable an authentication method

For the moment, cloud.sh uses third party OAuth exclusively. To configure the server, you should choose one of the following methods first. You can add more methods later in the Admin Panel.

GitHub

On GitHub, create an OAuth application (user settings > developer settings > OAuth Apps > New) with these settings:

• Homepage URL: http://YOUR_CLIENT_URL/
• Authorization callback URL: http://YOUR_CLIENT_URL/login

Then, on the configuration screen, complete these inputs:

• name: what you want to display to the user (eg. GitHub)
• color: the color to display on the login button
• client ID: the client ID given by GitHub
• client secret: the client secret given by GitHub
• authorize URL: https://github.com/login/oauth/authorize
• access token URL: https://github.com/login/oauth/access_token
• redirect URL: http://YOUR_CLIENT_URL/login