GoProject

Install and operate

Licence and the portal link

Adding the licence, what the daily report to the portal holds, and a closed network.

Licence

GoProject starts without a licence and asks for one. A licence is issued for one installation:

  1. Sign in as administrator and open Administration > Licence.
  2. Copy the Installation ID under "This installation" and send it with your licence request.
  3. Paste the licence key you receive under Add a licence and add it.

A renewal can be added before the current licence ends: it waits and takes over on its first day by itself.

Instead of pasting, you can lay the key down as a file. The application reads it at every start from storage/license, or from the path in LICENSE_FILE in .env:

install -o 10001 -g 10001 -m 640 licence.key storage/license
docker compose restart app

The portal link is a daily report from your installation to the GoProject portal. On a new installation it is off, and nothing is sent to the portal until an administrator switches it on or asks by hand.

What the report holds, and nothing else:

  • v - the format version of the report;
  • licenseId - the ID of the licence in force;
  • installationId - the installation ID;
  • publicKey - the installation's public key;
  • seatsInUse - how many seats are taken;
  • keyIssuedAt - when the licence key in force was issued;
  • at - when the report was made;
  • nonce - a random number, so that no report can be sent twice.

The report is signed with the installation's own key, so nobody else can report in its name. No user names, e-mail addresses, projects or work items are sent.

Where and when: https://goproject.lv/api/license/check-in, every hour at 20 minutes past, only while the link is on. Outgoing HTTPS only; nothing comes in.

What comes back: a renewed licence key, when one waits for this installation on the portal; the application installs it by itself. The answer also names the newest GoProject release, which Administration > System information shows. While the link is off, Administration > System information does not know the newest release until someone presses "Check now" on that page or "Check the link" under Portal link.

Switching it on: Administration > Licence > Portal link, tick "Synchronise with the GoProject portal". Every switch is written to the audit trail. "Check the link" sends one report straight away and works while the link is off too.

Through a proxy

If the server reaches the internet only through a proxy, add it to .env and apply it with docker compose up -d:

HTTPS_PROXY=http://proxy.example.com:3128

The proxy is used for the portal link only. A proxy that asks for a user name and password is not supported. Docker pulls the image through its own proxy settings, not through this one.

Closed network

Press "Download usage report" under Portal link, upload the file on the portal under your customer account, and paste the key it gives back under Add a licence. This works whether the link is on or off.