Setup

All steps mentioned here have to be executed in the backend/ folder.

DATABASE_URL is the Connection URI to your PostgreSQL database
BIND_ADDRESS_HOST defines the host on which the server will run on
BIND_ADDRESS_PORT defines the port on which the server will run on
AUTH_HOST defines the host on which the auth server is running on
AUTH_CLIENT_ID the client id the frontend should use to log in
KEYCLOAK_CLIENT_ID the client id the server uses to communicate with keycloak (needs to be configured in keycloak)
KEYCLOAK_CLIENT_SECRET the client secret the server uses to communicate with keycloak (needs to be configured in keycloak)
RUST_LOG used to set the logging config for env_logger
MODE Modes the backend can be run in. See doc/tests/mode.md.

To install an extension, a user needs to be a 'superuser',

The user 'permaplant' doesn't have the required permissions to create the 'postgis' extension.

Set it up using the postgres user.

Ensure that you grant the necessary permissions for the user to use Postgres.

One way to do this, is by using the following command:

sudo -u postgres psql
CREATE USER permaplant WITH CREATEDB PASSWORD 'permaplant';
ALTER USER permaplant WITH SUPERUSER;

Access-Control

To enable/disable the feature "access_control" add or remove the following line from /backend/Cargo.toml

default = ["access_control"]

Note: The feature "access_control" must be enabled if MODE=production is set.

To install dependencies.

make install

To update the database.

make migrations

make build

To use the preconfigured Keycloak instance simply copy the newest version of .env.sample to .env

To start the server

make run

Test server using Swagger

You can find other ways to make requests by following How to obtain access tokens.