Example

Tutorial

In this tutorial, we will create a simple application using Docker Compose and route the traffic to an accessible domain.

Steps

1. Create a new project.
2. Create a new service Compose and select the Compose Type Docker Compose.
3. Fork this repository: Repo.
4. Select Provider type: GitHub or Git.
5. Select the repository: deployi/docker-compose-test.
6. Select the branch: main.
7. Set the Compose Path to ./docker-compose.yml and save.

Updating Your docker-compose.yml

Add the following to your existing docker-compose.yml file:

1. Add the network deployi-network to each service.
2. Add labels for Traefik to make the service accessible through the domain.

Example:

Let's modify the following compose file to make it work with deployi:

version: "3"
 
services:
  next-app:
    build:
      context: ./next-app
      dockerfile: prod.Dockerfile
      args:
        ENV_VARIABLE: ${ENV_VARIABLE}
        NEXT_PUBLIC_ENV_VARIABLE: ${NEXT_PUBLIC_ENV_VARIABLE}
    restart: always
    ports:
      - 3000:3000
    networks:
      - my_network
networks:
  my_network:
    external: true

Updated version with deployi-network and Traefik labels:

version: "3"
 
services:
  next-app:
    build:
      context: ./next-app
      dockerfile: prod.Dockerfile
      args:
        ENV_VARIABLE: ${ENV_VARIABLE}
        NEXT_PUBLIC_ENV_VARIABLE: ${NEXT_PUBLIC_ENV_VARIABLE}
    restart: always
    ports:
      - 3000
    networks:
      - deployi-network
    labels:
      - "traefik.enable=true"
      - "traefik.http.routers.<unique-name>.rule=Host(`your-domain.com`)"
      - "traefik.http.routers.<unique-name>.entrypoints=websecure"
      - "traefik.http.routers.<unique-name>.tls.certResolver=letsencrypt"
      - "traefik.http.services.<unique-name>.loadbalancer.server.port=3000"
networks:
  deployi-network:
    external: true

Make sure to point the A record to the domain you want to use for your service.

Deploy the application by clicking on "deploy" and wait for the deployment to complete. Then give Traefik about 10 seconds to generate the certificates. You can then access the application through the domain you have set.

Tips:

1. Set unique names for each router: traefik.http.routers.<unique-name>
2. Set unique names for each service: traefik.http.services.<unique-name>
3. Ensure the network is linked to the deployi-network
4. Set the entry point to websecure and the certificate resolver to letsencrypt to generate certificates.