Commit 513e5a6e authored by Marek Veselý's avatar Marek Veselý
Browse files

Merge branch '91-add-required-version-for-docker-server-to-docs' into 'dux'

Resolve "Add required version for docker server to docs"

See merge request inject/inject-docs!151
parents 6f45ff6d 4012637b
Loading
Loading
Loading
Loading
Compare c2aabf7c to 88b86aef
Original line number Diff line number Diff line
Subproject commit c2aabf7c72f172666630ae9bba275aa300798cf2
Subproject commit 88b86aefdc5752b6a42713fdbcac4d6451b39b33
+2 −1
Original line number Diff line number Diff line
@@ -43,7 +43,8 @@ number of exercises and definitions stored at the same time.
### Software Requirements

- Linux operating system: Debian 11 or 12 is recommended
- [Docker Engine](https://docs.docker.com/engine/install/)
- [Docker Engine](https://docs.docker.com/engine/install/) with required version
    v25.0.0 or later
- [Docker Compose](https://docs.docker.com/compose/install/linux/) with
    recommended version v2.27.0

+20 −21
Original line number Diff line number Diff line
@@ -9,38 +9,37 @@ please be aware that the links used in this file may not work as expected.

If you encounter issues during deployment, consider the following steps:

- **Executable Permissions**: Ensure that the deployment scripts have executable
    permissions. Run the following command to set the appropriate permissions:
- **Executable Permissions**:
    Ensure that the deployment scripts have executable permissions.
    Run the following command to set the appropriate permissions:

    ```
    chmod +x deploy.sh 01-substitute-env.sh
    chmod +x deploy-with-https.sh generate-cert.sh  # If using HTTPS deployment
    ```

- **INJECT_DOMAIN Setting**: Verify that the INJECT_DOMAIN environment variable
    is set to a domain name and not a static IP address. The platform requires a
    domain name to function correctly. For local test deployments please use
    reserved TLD `.localhost` (example: `inject.localhost`)
- **INJECT_DOMAIN Setting**:
    Verify that the INJECT_DOMAIN environment variable is set to a domain name and not a static IP address.
    The platform requires a domain name to function correctly.
    For local test deployments please use reserved TLD `.localhost` (example: `inject.localhost`)

- **Backend is not returning any valid response**: Verify that the
    `INJECT_DOMAIN` and `INJECT_HOST_ADDRESSES` is set up correctly. The platform
    requires that the addresses are set up to hostnames where the platform is
- **Backend is not returning any valid response**:
    Verify that the `INJECT_DOMAIN` and `INJECT_HOST_ADDRESSES` is set up correctly.
    The platform requires that the addresses are set up to hostnames where the platform is
    expected to be accessed from.

- **Frontend's error log in Developer Console is reporting mixed-origin
    connection issues**: Verify that connection settings in the environment
    variables are set up correctly. If using HTTP deployment, that they use
    `http://` and `ws://` protocol, and when using HTTPS, then `https://` and
    `wss://`.
- **Frontend's error log in Developer Console is reporting mixed-origin connection issues**:
    Verify that connection settings in the environment variables are set up correctly.
    If using HTTP deployment, that they use `http://` and `ws://` protocol, and when using HTTPS,
    then `https://` and `wss://`.

- **Application is connecting to an incorrect backend instance**: Clean up your
    browser local storage to enforce rebinding of the Frontend client.
- **Application is connecting to an incorrect backend instance**:
    Clean up your browser local storage to enforce rebinding of the Frontend client.

- **The application shows an error about frontend and backend versions not being
    compatible**: This usually happens after upgrading to a new version of the
    platform. To resolve this, clear your browser's cache to ensure that the
    frontend loads the latest version and can properly communicate with the
    backend.
- **The application shows an error about frontend and backend versions not being compatible**:
    This usually happens after upgrading to a new version of the platform.
    To resolve this, clear your browser's cache to ensure that the frontend loads
    the latest version and can properly communicate with the backend.

<div class="navigation" markdown>
  [&larr; Installation overview](./overview.md){ .md-button }