Commit cf9cd670 authored by Tomáš Hájek's avatar Tomáš Hájek
Browse files

Merge branch 'update-definitions' into 'dux'

Update available definitions

See merge request inject/inject-docs!153
parents 513e5a6e 363115f9
Loading
Loading
Loading
Loading
Compare 7b2ecf6d to e3d5264d
Original line number Diff line number Diff line
Subproject commit 7b2ecf6d5ccc0e77e6409fa7e7e5c0bfecc9611d
Subproject commit e3d5264db7aa8d81cd9fd0fe64238236c07feb01
Compare 88b86aef to 332af7ec
Original line number Diff line number Diff line
Subproject commit 88b86aefdc5752b6a42713fdbcac4d6451b39b33
Subproject commit 332af7ec9770a3c0db26c5ea045170184e2447a3
+2 −0
Original line number Diff line number Diff line
@@ -8,6 +8,8 @@

The INJECT team has prepared an example content that is available to you for the ease of adoption of IXP.

- All the zip files contain `README.md`, where you can find additional information about the exercise definition.

!!! Warning

    The provided exercise definitions are of definition version 0.23.3 and work only with platform version 4.0.X.
+3 −0
Original line number Diff line number Diff line
@@ -138,8 +138,11 @@ The available variables are listed below:
**Database**

- `INJECT_DB_HOST` – Hostname or IP address of the PostgreSQL database server.

- `INJECT_DB_USER` – Username for connecting to the database.

- `INJECT_DB_PASS` – Password for the database user.

- `INJECT_DB_MAX_CONNECTIONS` – Sets the maximum number of connections that PostgreSQL can accept.
    Approximate formula for how many connections will be used:
    `2 x INJECT_WORKER_COUNT +   maximum expected running synchronous exercise count +   maximum expected running team count in on-demand exercises`.
+22 −26
Original line number Diff line number Diff line
<!--
Note: This file is primarily defined to be used in the IXP documentation.
However, it is also provided in the docker-deployment repository for reference.
If you accessed this file from the docker-deployment repository,
please be aware that the links used in this file may not work as expected.
-->
<!-- Note: This file is primarily defined to be used in the IXP documentation. However, it is also provided in the docker-deployment repository for reference. If you accessed this file from the docker-deployment repository, please be aware that the links used in this file may not work as expected. -->

## Troubleshooting

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 setup correctly. The platform
    requires that the addresses are setup 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
    varibles are setup correctely. 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 }
Loading