Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

Table of contents

Table of Contents
minLevel1
maxLevel7
typeflat

Foreword

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

  • Adjust some of the paths

  • Set personnal administor credentials and default database content

...

Docker repository access

SAMDistImages/Configuration.conf

...

Make sure IMAGE_SOURCE_REPOSITORY points to “localhost” and to a directory of your choice. For example:

Code Block
IMAGE_SOURCE_REPOSITORY=localhost:5000/sambackend/distimages
Note

If you started Docker on a different port than 5000 (see Local Docker repository paragraph) then you will need to change the port number targeted in IMAGE_SOURCE_REPOSITORY.

...

Retrieve the Dockers/SAMDeployment directory from the development project located at svn://svn.agnos.ca:3890/abc/Products/SamBackEnd/trunk into the environment where it will be installed.

...

make the SAMDeployment directory current.

...

Edit the Configuration.conf file. Set the parameters accordingly to your environment.

SAMDeployment/Configuration.conf

Make sure IMAGE_SOURCE_REPOSITORY and IMAGE_DEPLOYMENT_REPOSITORY point to “localhost” and to a directory of your choice. For example:

Code Block
IMAGE_SOURCE_REPOSITORY=localhost:5000/sambackend/distimages
IMAGE_DEPLOYMENT_REPOSITORY=localhost:5000/sambackend/demoimages
Note

If you started Docker on a different port than 5000 (see Local Docker repository paragraph) then you will need to change the port number targeted in IMAGE_SOURCE_REPOSITORY.

Then, customize your actual repository location by modifying STORAGE_BASE_DIRECTORY. For example:

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

Database access

Warning

All the parameters from SAMDeployment/Configuration.conf file can be changed to your liking, especially the DATABASE_USER, DATABASE_PASSWORD and ROOT_DATABASE_PASSWORD fields which should absolutely NOT de the default values in production.

Certificates

Replace the certificate (fullchain.pem) and the private key (privkey.pem) in

...

SAMDeployment/Server/resources

...

/ by your own.

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:

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

    You can also generate a new one from the /var/www/html directory in the SAM backend container by running the command

    Code Block
    php artisan key:generate

  2. docker login dev.atheos.ca:5000

  3. Initialize the permanent storage

    Code Block
    make initstorage
  4. Initialize the database

  5. Code Block
    make initdatabase
  6. Create the images

    Code Block
    make images 
  7. Launch the SAM backend by issuing the following command.

    Code Block
    make run
  8. Optionally, install phpmyadmin for debugging purposes. It is not recommended. Customize the files fullchain.pem, passwd and privkey.pem in the resources directory. passwd is created with htpasswd. It contains the Apache2 passwords. Launch it by issuing the following commands:

    Code Block
    cd PhpMyAdmin 
    make images
    make run

...

  1. Preserve the file Configuration.conf from the previous SAMDeployment package.

  2. Preserve APP_KEY value from the .env file in the Server Docker. If needed, update SAMDeployment/Server/templates/laravel_env. The value of APP_KEY must be preserved. If lost, you SAM backend environment will have many issues.

  3. Stop the containers samserver_xx.yy.zz, samphpmyadmin_xx.yy.zz and samdatabase_xx.yy.zz

  4. Make a backup of your storage structure set using the Configuration.conf variable STORAGE_BASE_DIRECTORY

  5. Make sure you use the latest version of SAMDeployment

  6. Bump up the version number in the Configuration.conf file

  7. Update Configuration.conf matching the corresponding parameters from your previous one.

  8. Fill in any new configuration parameters.

  9. run make images

  10. run make run

  11. The container databaseupdate has a very short life span. It terminates as soon as the database is updated.