Skip to main content

Networking FAQ

All frequent questions related to networking.

How to configure HTTPS scheme for accessing Unstract?​

  1. Set the following to True in backend/.env:

    SESSION_COOKIE_SECURE=True
    CSRF_COOKIE_SECURE=True

  2. Update scheme to HTTPS in backend/.env:

         # Django settings
         DJANGO_APP_BACKEND_URL=https://<your_host>

         # FE Web Application Dependencies
         LOGIN_NEXT_URL="https://<your_host>/org"
         LANDING_URL="https://<your_host>/landing"
         ERROR_URL="https://<your_host>/error"
         WEB_APP_ORIGIN_URL="https://<your_host>"

  3. See here to deploy Unstract behind your existing ALB or Nginx reverse proxy OR see here to change port, if required.

  4. Do docker compose down and then up for backend service.

How to access Unstract via another host?​

  1. Update domain or IP address in docker/docker-compose.yaml:

      # Under backend service labels
      - traefik.http.routers.backend.rule=Host(`<your_host>`) && PathPrefix(`/api/v1`, `/deployment`)

      # Under frontend service labels
      - traefik.http.routers.frontend.rule=Host(`<your_host>`)

  2. Update domain or IP address in backend/.env:

        # Django settings
        DJANGO_APP_BACKEND_URL=http://<your_host>

        # FE Web Application Dependencies
        LOGIN_NEXT_URL="http://<your_host>/org"
        LANDING_URL="http://<your_host>/landing"
        ERROR_URL="http://<your_host>/error"
        WEB_APP_ORIGIN_URL="http://<your_host>"

  3. See here to configure HTTPS scheme, if required.

  4. Do docker compose down and then up for backend and reverse-proxy services.

How to run Unstract on another port?​

  1. Update port in backend/.env:

        # Django settings
        DJANGO_APP_BACKEND_URL=http://<your_host>:<your_port>

        # FE Web Application Dependencies
        LOGIN_NEXT_URL="http://<your_host>:<your_port>/org"
        LANDING_URL="http://<your_host>:<your_port>/landing"
        ERROR_URL="http://<your_host>:<your_port>/error"
        WEB_APP_ORIGIN_URL="http://<your_host>:<your_port>"

  2. Update port in docker/docker-compose-dev-essentials.yaml:

      # Under reverse-proxy service labels
      - "80:80"            (OLD)
      - "<your_port>:80"   (NEW)

  3. See here to change the host, if required.

  4. Do docker compose down and then up for backend and reverse-proxy services.

I already have a ALB/Nginx acting as reverse proxy. How can I deploy Unstract behind it?​

Please change the default host and/or run on another port, as needed.

Once done, start forwarding requests from your ALB/Nginx to the IP address and port of the unstract-proxy container (in which the reverse-proxy docker compose service is running).

The actual ALB/Nginx configuration can be easily obtained online hence is outside the scope of this documentation.