GoFAST Community : Installation et Mise à Jour

Note

In case of problems you can ask your questions on the forums: https://community.ceo-vision.com

Installation (par conteneurs)

Note

If you got to this page from the GoFAST Community form, you can skip directly to step 2

Étape 1 : Rendez-vous sur: https://gofast-ng.ceo-vision.com/ (Option “Installation”)

Once you have completed the link form above and clicked on the link sent to you by e-mail, please proceed as follows :

When you go to the download interface, a configuration page appears, it consists of 4 steps :

– Configuring the domain name

– Configuring the SSL certificate

– The configuration of the SMTP server

– The configuration of the platform administrator account

Step 2 : Configuring the Domain Name

On this screen you configure the name and domain of your GoFAST Community :

Site name : This is the name that will appear in the tabs for example

Full Domain Name : This is your organization’s usual domain name e.g. gofast.company-xyz. com

Step 3 : Configuring the SSL Certificate

You must load x509 base64-encoded certificates corresponding to the domain name entered above.

You must provide :

the public key of your certificate (.pem or .crt)
**Intermediate authority (CA) certificate ** (.pem or .crt)
the private key corresponding to the certificate (.key)

Note

If you do not know what it is, these certificates take the form of two files to ask your IT department

Warning

At the moment this interface does not allow to generate self-signed certificates, if you want to generate one for test use only, you can use an online tool like https://regery.com/en/security/ssl-tools/self-signed-certificate-generator

Step 4: SMTP Server Configuration

This 4th step allows you to configure the SMTP server used by GoFAST to send emails. The required fields are :

SMTP Server: The domain name or IP of your SMTP server

Username: If authentication is required, the username

Password : If authentication is required, the password

Security : To be filled in according to the security protocol used

SMTP Port : The port of your SMTP server

Note

If you do not have an SMTP server, you can specify an SMTP server that does not exist (Example: smtp.example.org)

Step 5 : Creating the Administrator User

Configuration Functional Administrator

The section Admin Account Configuration allows you to enter the credentials of the first account created on GoFAST that you will use to log in.

You must choose the username, password and email address for this account.

Warning

It is not possible to choose ‘admin’ for the username which is a reserved account for the technical administrator account (see below).

Configuration Technical Administrator

The section Technical Password is reserved for the technical administrator account of the platform. You can set each password by unchecking Use technical password for all services.

As a user you will not normally have to use this technical account.

Step 6 : Confirm the configuration

Warning

Before clicking on “Get Compose”, please check all fields before proceeding to download.

Once these steps are completed, a page appears with a summary. If everything is correct, validate the configuration.

After validating the download, it will upload two files to a .zip archive:

An .env containing all the variables entered
A compose.yaml file containing the description of the containerized GoFAST application

Step 7: Install your platform

Caution

GoFAST is a business application and requires a server (mini 4vcpu,12GB RAM,SSD recommended). Use on a simple PC with Podman Desktop or Docker Desktop is therefore not recommended.

Note

To access the application, declare its domain name (entered in step 2) together with its IP address in your computer’s hosts file (https://www.digdeo.fr/articles/sys-admin/modifier-fichier-etc-hosts-windows-mac-linux) or in the company’s DNS

Note

Many technical operations will be carried out as well as service starts, which may take more or less time depending on the capabilities of the server. The estimated time for first start-up is between 10 and 30 min.

On a Linux machine - RedHat (Recommended: AlmaLinux or CentOS)

Install podman, podman-compose and unzip packages using the appropriate package manager (yum or dnf depending on your version)

dnf install podman-compose podman unzip
yum install podman-compose podman unzip

Unzip and copy the .env and compose.yaml files to the folder of your choice

mkdir /opt/gofast
cd /opt/gofast
unzip gofast-community.zip

Instance your GoFAST Community

podman-compose up -d

Follow the progress of your installation

podman logs -f gofast-ng-drupal
podman logs -f gofast-ng-alfresco
podman logs -f gofast-ng-mysql
podman logs -f gofast-ng-....

Note

Once the command “podman logs -f gofast-ng-drupal” returns the hand, it means that the installation is complete.

On Windows with Docker Desktop and Portainer

Create a folder on the PC and unzip gofast-community.zip inside
Install the Docker Desktop app: https://www.docker.com/products/docker-desktop/

Note

When installing keep the default settings, including the use of WSL 2. A restart of Windows will be required.

Caution

After restarting Windows when opening Docker Desktop, if the message “Docker Desktop requires a newer WSL kernel version” is displayed, follow the “Update the WSL Kernel” procedure in the “Known Issues” section.

In Docker Desktop click on “Add Extensions” in the left menu and install the “Portainer” extension. This extension will allow you to initialize GoFAST Community in a simple way.
Open the extension “Portainer” in the left menu and click on “Get started”
Dans Portainer sélectionner l’environnement “local” en cliquant ci-dessus
In Portainer click on the “Stacks” menu (in the small vertical menu between the left menu and the main window)
Add a new stack using the “+ Add Stack” button
Give it a name, say “gofast-community”
Sélectionnez la méthode “Upload”
In “Upload”, load your compose.yaml
In “Environment variables” click on “Load variables from .env file”
To finalize the instantiation, click at the bottom on “Deploy the stack”

Caution

This process once started will download all images of GoFAST applications, this process may take time. Do not leave or change menu while you see “Deployment in progress…”

Mise à jour (par conteneurs)

Étape 1 : Rendez-vous sur: https://gofast-ng.ceo-vision.com/ (Option ‘Mise à jour’)

Retrieve the .env file generated during installation of GoFAST Community, then load it into the interface.

Validate recovered parameters

On subsequent configuration screens, you can confirm the parameters retrieved from your .env environment file.

Some parameters can be modified, such as :

Site name : This is the name that will appear in the tabs for example

the public key of your certificate (.pem or .crt)

**Intermediate authority (CA) certificate ** (.pem or .crt)

the private key corresponding to the certificate (.key)

Note

If you do not know what it is, these certificates take the form of two files to ask your IT department

Warning

At the moment this interface does not allow to generate self-signed certificates, if you want to generate one for test use only, you can use an online tool like https://regery.com/en/security/ssl-tools/self-signed-certificate-generator

Once these steps are completed, a page appears with a summary. If everything is correct, validate the configuration.

After validating the download, it will upload two files to a .zip archive:

An .env containing all the variables entered
A compose.yaml file containing the description of the containerized GoFAST application

Etape 3 : Mettre à jour votre plateforme

Caution

GoFAST is a business application and requires a server (mini 4vcpu,12GB RAM,SSD recommended). Use on a simple PC with Podman Desktop or Docker Desktop is therefore not recommended.

Note

To access the application, declare its domain name (entered in step 2) together with its IP address in your computer’s hosts file (https://www.digdeo.fr/articles/sys-admin/modifier-fichier-etc-hosts-windows-mac-linux) or in the company’s DNS

Note

Many technical operations will be carried out as well as service starts, which may take more or less time depending on the capabilities of the server. The estimated time for first start-up is between 10 and 30 min.

On a Linux machine - RedHat (Recommended: AlmaLinux or CentOS)

Arrêter votre GoFAST Community

cd /opt/gofast #(Ou votre dossier d'installation)
podman-compose down

Déziper et remplacer les fichiers .env et compose.yaml dans le même dossier que votre installation précédente

cd /opt/gofast #(Ou votre dossier d'installation)
unzip gofast-community.zip

Restarting your GoFAST Community

podman-compose up -d

Follow the progress of your installation

podman logs -f gofast-ng-drupal
podman logs -f gofast-ng-alfresco
podman logs -f gofast-ng-mysql
podman logs -f gofast-ng-....

Note

Once the command “podman logs -f gofast-ng-drupal” returns the hand, it means that the installation is complete.

On Windows with Docker Desktop and Portainer

Documentation in preparation

Installation (pour AWS)

This installation method will be back soon.

Update (for AWS)

This installation method will be back soon.

Let’s go!

Go to the domain name you have chosen https://gofast.entreprise-xyz.com.

You need to create some users and collaborative spaces (and subspaces).

Spaces can be of different types, “Organization” (departments, …), “Groups” (projects, …), “Extranet” (partners, clients, …). See the online documentation here: https://gofast-docs.readthedocs.io/fr/latest/docs-gofast-users/doc-gofast-guide-utilisateurs.html#gerer-un-espace-collaboratif-groupe

Dans les sous-espaces créés, ajoutez des membres qui pourront avoir accès au contenu de cet espace. Ajoutez des sous-espaces si nécessaire.

Add content using drag-and-drop in the “GoFAST File Browser”

You’re ready to go!

Known issues

Updating the WSL Kernel

If a WSK kernel update is required, go to https://docs.microsoft.com/windows/wsl/wsl2-kernel

Download the proposed “WSL2 Linux Kernel Update Package” and run it.

You can then restart Docker Desktop.

Renaming and migration to GoFAST 4.3.0

Version 4.3.0 of GoFAST NG has introduced a change in container naming as part of the move to GoFAST Enterprise.

This renaming creates new volumes, so if you don’t want to start from scratch, you can use the following procedure.

Caution

Before following this procedure, you must have updated your instance to 4.3.0 or higher.

Caution

This procedure should only be followed if you are updating an existing instance of GoFAST Community < 4.3.0 to GoFAST Community >= 4.3.0.

Note

This procedure applies to container installations on a Linux machine such as RedHat. For other types of installation, you can make a request on the forums: https://community.ceo-vision.com

On a Linux machine - RedHat (Recommended: AlmaLinux or CentOS)

Check that volumes exist with both old and new names

podman volume ls

You should see a list of ‘gofast-ng-community’ and ‘gofast-ng-main-community’ volumes:

DRIVER      VOLUME NAME
local       gofast-ng-community_gofast-ng-mysql_data
local       gofast-ng-community_gofast-ng-share_data
local       gofast-ng-community_gofast-ng-www_data
local       gofast-ng-community_gofast-ng-drupal_data
local       gofast-ng-community_gofast-ng-ldap_data
local       gofast-ng-community_gofast-ng-alfresco_data
local       gofast-ng-community_gofast-ng-solr_data
local       gofast-ng-community_gofast-ng-clamav_data
local       gofast-ng-main-community_gofast-ng-mysql_data
local       gofast-ng-main-community_gofast-ng-share_data
local       gofast-ng-main-community_gofast-ng-www_data
local       gofast-ng-main-community_gofast-ng-ldap_data
local       gofast-ng-main-community_gofast-ng-alfresco_data
local       gofast-ng-main-community_gofast-ng-solr_data
local       gofast-ng-main-community_gofast-ng-keycloak_data
local       gofast-ng-main-community_gofast-ng-saslauthd_sock

So we’re going to migrate the data from the old volumes to the new ones.

Before making the change, check that the initialization of your GoFAST Community has been completed. The following command should return your hand:

podman logs -f gofast-ng-drupal

You can also check that the gofast-ng-drupal container has completed its initialization (it should be in the Exited state):

podman ps -a | grep gofast-ng-drupal

Arrêter votre GoFAST Community

podman-compose down

Migrate volumes

podman run --rm -it -v gofast-ng-community_gofast-ng-mysql_data:/from:z -v gofast-ng-main-community_gofast-ng-mysql_data:/to:z alpine ash -c 'cd /from ; rm -Rf /to/* ; cp -aRf ./* /to/'
podman run --rm -it -v gofast-ng-community_gofast-ng-www_data:/from:z -v gofast-ng-main-community_gofast-ng-www_data:/to:z alpine ash -c 'cd /from ; rm -Rf /to/* ; cp -aRf ./* /to/'
podman run --rm -it -v gofast-ng-community_gofast-ng-ldap_data:/from:z -v gofast-ng-main-community_gofast-ng-ldap_data:/to:z alpine ash -c 'cd /from ; rm -Rf /to/* ; cp -aRf ./* /to/'
podman run --rm -it -v gofast-ng-community_gofast-ng-alfresco_data:/from:z -v gofast-ng-main-community_gofast-ng-alfresco_data:/to:z alpine ash -c 'cd /from ; rm -Rf /to/* ; cp -aRf ./* /to/'
podman run --rm -it -v gofast-ng-community_gofast-ng-solr_data:/from:z -v gofast-ng-main-community_gofast-ng-solr_data:/to:z alpine ash -c 'cd /from ; rm -Rf /to/* ; cp -aRf ./* /to/'

Restarting your GoFAST Community

podman-compose up -d

Once your instance has started, you can connect to it and check that the installation has been reset to the desired state. If all is in order, you can proceed to delete the old volumes:

podman volume rm gofast-ng-community_gofast-ng-mysql_data
podman volume rm gofast-ng-community_gofast-ng-share_data
podman volume rm gofast-ng-community_gofast-ng-www_data
podman volume rm gofast-ng-community_gofast-ng-drupal_data
podman volume rm gofast-ng-community_gofast-ng-ldap_data
podman volume rm gofast-ng-community_gofast-ng-alfresco_data
podman volume rm gofast-ng-community_gofast-ng-solr_data
podman volume rm gofast-ng-community_gofast-ng-clamav_data

On Windows with Docker Desktop and Portainer

Faire une demande sur les forums : https://community.ceo-vision.com