...

Foreword

Before running the installation sequence, one needs to update the installation scripts to:

...

STORAGE_BASE_DIRECTORY=/home/<username>/Downloads/backend/v01.00.06b/Storage

Database

...

Access

Default content

When built, the backend database is pre-filled with SQL requests contained in SAMDistImages/Database/resources/004_SAMBackendData.sql. You can modify that file to have your own Users, Devices, etc...

Once the files have been edited to your convenance, run the installation commands.

The backend database can be seeded through the files contained in database/seeders/*.php. To modify those files, connect to the docker terminal with the following command:

docker exec -it php /bin/bash

You can then edit the files with vi. Once edited, to fill the database with the seeds content, run the following command:

php artisan db:seed

Crypto provider

Crypto provider location is a specific case of the above mentioned “default content”. The crypto provider domain name is defined in the SystemParameters table, SMCryptoProviderDomain element and optionally the SMCryptoProviderSubdomain element. The crypto provider port is defined in the SystemParameters table, SMCryptoProviderPort element. Both are configured as String.

Crypto provider information must be set in the .env file as follows:

# Cryptoprovider setup
CRYPTOPROVIDER_DOMAIN=<domain>
#CRYPTOPROVIDER_SUBDOMAIN=<subdomain>
CRYPTOPROVIDER_PORT=<port>
CRYPTOPROVIDER_CHECKSSL=<...> (false, true or path to SSL certificates)

Gateway

Crypto provider information must be set in the .env file as follows:

# Gateway setup
GATEWAY_DOMAIN=<domain>
#GATEWAY_SUBDOMAIN=<subdomain>
GATEWAY_PORT=<port>
GATEWAY_CHECKSSL=<...> (false, true or path to SSL certificates)
GATEWAY_ENABLE=<bool> (false or true)

Certificates

Replace the certificate (fullchain.pem) and the private key (privkey.pem) in SAMDeployment/Server/resources/ by your own.

The server SSL certificates are located into the Caddy HTTP container, under the /etc/ssl/caddy directory. The files to be replaced are ca.pem the CA root certificate, cert.pem the server certificate and ca.key the server private key.

Application key

You must replace the APP_KEY in the SAMDeployment/Server/templates/laravel_env file. You can generate a new one using the following command:

echo "base64:`dd if=/dev/random bs=32 count=1 | base64`"

Default database content

When built, the backend database is pre-filled with SQL requests contained in SAMDistImages/Database/resources/004_SAMBackendData.sql. You can modify that file to have your own Users, Devices, etc...

...

Time synchronization

To adjust the Docker images time and date to your current location, please update the ““ENV TZ” variable located in the following Dockerfiles:

• SAMDistImages/Server/Dockerfile

• SAMDistImages/Database/Dockerfile

The default value is set to “Europe/Paris”

Timezone information must be set in the .env file as follows:

# Timezone set to Europe
TZ="Europ/Paris"

Key embedding tool

The Key Embedding Tools comes with two flavours (debug vs. production). The tool selection is automatic, based on the APP_ENV variable from the .env file.

# Deployment type
APP_ENV=dev (or prod)