Installation

This page will guide you through the installation process of this application.

Requirements

The following instructions assume that you have already installed Docker and Docker Compose on your server. If not, please refer to the official documentation for more information.

Get docker-compose.yml

First, create a new directory for the application and download the latest docker-compose.yml file from the repository.

curl

Download docker-compose.yml

https://raw.githubusercontent.com/timokoessler/docker-deploy-api/main/docker-compose.yml
--output docker-compose.yml ```
</TabItem>
<TabItem label="wget">
```bash title="Download docker-compose.yml" frame="terminal" wget
https://raw.githubusercontent.com/timokoessler/docker-deploy-api/main/docker-compose.yml

Configure the application

Open the docker-compose.yml file in your favorite editor and adjust the following settings:

...
    ports:
        # Always use a reverse proxy like nginx to proxy the requests to this container
        - '127.0.0.1:8080:3000'
        - '127.0.0.1:8081:3000' # Change to a non public unused port
    environment:
        - URL=http://127.0.0.1:8080 # Public url of the api
        - URL=https://deploy.example.com # Your public url
        - PORT=3000 # The port the api is listening on (inside the container)
...

Change the URL to the public url of your application and modify the ports setting to a non public port that is not used by another application on your server. You can also use Docker networks to communicate with the container from other containers.

Tip

You can find all available configuration options on the configuration page.

Configure the reverse proxy

The application is designed to be used behind a reverse proxy like nginx, that handles the tls termination and proxies the requests to the application. You can find example proxy configurations on the page Reverse Proxy.

Start the application

Finally, start the application with the following command:

docker compose up -d

Make sure the container is not restarting and check the logs for any errors:

docker compose logs -f

If you open the url of your application in your browser, you should see a welcome page. Congratulations, you have successfully installed the application! 🎉

Next steps

• If you want to pull images from a private registry, you can find more information on the page Private Registry Authentication.
• You can find an guide on how to create a Deploy Token on the page Generate Deploy Token.
• You can find all available configuration options on the page Configuration.