Installation

1. Install PostgreSQL

2. Install Docker

3. Create PostgreSQL role with password for backend (in example code username “biogas”)

4. Create database (in example code “digibiogashub”)

   sudo -i -u postgres
   createuser --interactive
   Enter name of role to add: biogas
   Shall the new role be a superuser? (y/n) n
   Shall the new role be allowed to create databases? (y/n) n
   Shall the new role be allowed to create more new roles? (y/n) n
   psql
   \password biogas
   Enter new password for user "biogas":
   Enter it again:
   CREATE DATABASE "digibiogashub" OWNER biogas;

5. Clone the repository

6. Change directory to project folder

7. Create .env file in src folder

   git clone https://github.com/CentriaUniversityOfAppliedSciences/DigiBioGasHub-backend.git
   cd DigiBioGasHub-backend
   nano src/.env

   SERVER_PORT=28765
   POSTGRES_USER=username #username you created in #3
   POSTGRES_DB=database #database you created in #4
   POSTGRES_PASSWORD=password #password you created in #3
   DB_HOST=localhost #address to your PostgreSQL installation
   DB_PORT=5432 #port number of PostgreSQL installation
   JWT_KEY=your-secret-jwt-key #secret key to create JWT needs to match with one in cubejs .env and in chat .env
   MML_API_KEY=your-mml-api-key #https://www.maanmittauslaitos.fi/en/rajapinnat/api-avaimen-ohje 
   MINIO_ROOT_USER=your-minio-user 
   MINIO_ROOT_PASSWORD=your-minio-password 
   MINIO_DEV=false #false will use http://localhost:9000, if true then uses MINIO_ADDRESS in links to files
   MINIO_ADDRESS=your_address_for_minio
   EMAIL_SENDER=sender_email_smtp_username
   EMAIL_PASS=sender_email_smtp_password 
   SERVER_ADDRESS=address_to_frontend  #development http://localhost:8100
   HUB_NAME=name_of_your_hub  #default hub created on first start
   HUB_ORIGIN=url_address_of_your_hub  #(local dev is ionic address http://localhost:8100)  
   HUB_ADMIN_USER=username_for_default_admin  #needs to be email e.g. admin@admin.fi
   HUB_ADMIN_PASS=password_for_default_admin  #needs to be atleast 8 char long
   USE_PAYMENT=false
   STRIPE_SECRET_KEY=sk_ #leave like this if you do not have stripe account
   STRIPE_WEBHOOK_SECRET=whsec_ #leave like this if you do not have stripe account
   THREE_MONTHS_SUBSCRIPTION_PRICE=price_ #leave like this if you do not have stripe account
   SIX_MONTHS_SUBSCRIPTION_PRICE=price_ #leave like this if you do not have stripe account
   TWELVE_MONTHS_SUBSCRIPTION_PRICE=price_ #leave like this if you do not have stripe account

8. Move out of DigiBioGasHub-backend folder

9. Install min.io (https://github.com/minio/minio) file storage

   for Ubuntu (some commands might need to be run as sudo)

   cd ..
   wget https://dl.min.io/server/minio/release/linux-amd64/minio
   chmod +x minio
   mv minio /usr/local/bin/
   groupadd -r minio-user
   useradd -M -r -g minio-user minio-user
   mkdir -p /mnt/data/disk1
   chown minio-user:minio-user /mnt/data/disk1

10. Configure min.io and run it as service

    change username and password in DigiBioGasHub-backend/minio -file to match .env MINIO_ROOT_USER and MINIO_ROOT_PASSWORD

    cd DigiBioGasHub-backend
    nano minio
    cp minio /etc/default/minio
    cp minio.service /etc/systemd/system/minio.service
    systemctl enable minio.service
    systemctl start minio.service

11. Start docker

    docker compose up

On first run the backend server will create an superadmin user and a default hub for the system. Username and password for the superadmin are set in .env. Change the superadmin password!!! It might be necessary to open port on firewall or vm settings to access backend

Payment Integration (Optional) link

Integrate Stripe payments into your backend by following these steps. Note!! If you wish to use Stripe payment system, set environment variable VITE_USE_PAYMENT=true in frontend and USE_PAYMENT=true in backend

1. Set Up Stripe link

1. Create an account on Stripe.
2. In the Stripe dashboard, obtain your Stripe Secret Key (STRIPE_SECRET_KEY).
3. Create product and get the stripe price ids (THREE_MONTHS_SUBSCRIPTION_PRICE, SIX_MONTHS_SUBSCRIPTION_PRICE, TWELVE_MONTHS_SUBSCRIPTION_PRICE).
4. Update backend environment variables in your .env file.

2. Configure Stripe Webhook link

1. In your Stripe dashboard, create a Webhook Endpoint.

2. Subscribe the endpoint to these events:

   • checkout.session.completed
   • checkout.session.expired

3. Set the Destination URL to

   https://your-domain/webhook

4. Obtain your Stripe webhook secret (STRIPE_WEBHOOK_SECRET)

   When testing locally, replace your-domain with your ngrok URL (see next section).

5. Update backend environment variables in your .env file.

3. Local Development with ngrok link

If you are running the application on your local machine:

1. Sign up for a free account at ngrok.

2. Install ngrok.

3. On a free ngrok account, you can reserve one static domain.Go to the “Domains” section in your ngrok dashboard and reserve a subdomain.

4. Authenticate ngrok with your authtoken:

   ngrok config add-authtoken $YOUR_AUTHTOKEN

4. Configure traffic-policy.yml link

1. Open the file traffic-policy.yml. ( backend root folder )

2. Set the Origin to your ngrok URL, e.g.:

   Origin:  https://hawk.ngrok-free.app

5. Start ngrok with Traffic Policy link

Navigate to the directory containing traffic-policy.yml, then run:

ngrok http --url=your-ngrok-domain 28765 --traffic-policy-file traffic-policy.yml

• 28765 is the local port your application listens on- adjust if necessary.

Reminder
After ngrok is running, update your Stripe webhook’s destination URL to match the active ngrok URL whenever it changes. e.g.:

  https://hawk.ngrok-free.app/webhook