Commit f30e492c authored by Marek Veselý's avatar Marek Veselý
Browse files

Merge branch '4-core-cpu' into 'main' 

sync inject-docs main with docker-deployment

Closes inject-issues#285

See merge request inject/inject-docs!171
parents ede8e19f e87e3d04

docker-deployment @ 39a25faf

Compare 332af7ec to 39a25faf
Original line number Diff line number Diff line 
Subproject commit 332af7ec9770a3c0db26c5ea045170184e2447a3
 
Subproject commit 39a25faf79dbc01d3622410d1c0e3d8f20d44283

docs/tech/installation/overview.md

+1 −1
Original line number Diff line number Diff line
@@ -17,7 +17,7 @@ documentation. 


Before you begin, ensure that you have the following:



- a server with at least a 2-core CPU and 8 GB RAM,

- a server with at least a 4-core CPU and 8 GB RAM,

- a 64-bit x86 architecture,

- root or sudo access to the server,

- and at least 4 GB of disk space, although more is necessary for long-term

docs/tech/installation/setup.md

+2 −3
Original line number Diff line number Diff line
@@ -115,6 +115,8 @@ The available variables are listed below: 
- `CORS_ALLOWED_ORIGINS` – Comma-separated list of origins allowed for

    Cross-Origin Resource Sharing (CORS), enabling secure API access from

    specified domains.

- `INJECT_REQUEST_TIMEOUT` – A number of seconds which should be set as the

    timeout value in NGINX.



**Email Configuration**
@@ -138,11 +140,8 @@ 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`.

docs/tech/installation/troubleshooting.md

+26 −22
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 setup correctly. The platform

    requires that the addresses are setup 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

    varibles are setup correctely. 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 }