Docker

We will go over how to install Petio using Docker or Docker Compose. We assume you have installed Docker and/or Docker Compose.
This guide will not walk you through how to install or configure any of these two services.
Docker CLI
1
docker run --rm \
2
    --name petio \
3
    -p 7777:7777 \
4
    -e TZ="Etc/UTC" \
5
    --user 1000:1000 \
6
    -v /<host_folder_config>:/app/api/config \
7
    ghcr.io/petio-team/petio
Copied!
1
docker run --rm \
2
    --name mongo \
3
    -e TZ="Etc/UTC" \
4
    --user 1000:1000 \
5
    -v /<host_folder_db>:/data/db \
6
    mongo:4.4
Copied!
Docker Compose
There are two ways you can install Petio using Docker Compose. You can either download the docker-compose.yml from the repo and place it in a folder where you will run docker-compose from or you can add it to an existing docker-compose.yml.
To download the Docker Compose file you run the following command:
1
curl -OL https://github.com/petio-team/petio/raw/master/docker-compose.yml -o /path/to/location
Copied!
Below you can find an example for the docker-compose.yml. In this example, petio and mongo are on a custom docker network called petio-network
1
version: '3'
2
​
3
networks:
4
    petio-network:
5
        driver: bridge
6
​
7
services:
8
    petio:
9
        image: ghcr.io/petio-team/petio:latest
10
        container_name: petio
11
        hostname: petio
12
        ports:
13
            - '7777:7777'
14
        networks:
15
            - petio-network
16
        user: '1000:1000'
17
        depends_on:
18
            - mongo
19
        environment:
20
            - TZ=Etc/UTC
21
        volumes:
22
            - ./config:/app/api/config
23
            - ./logs:/app/logs
24
​
25
    mongo:
26
        image: mongo:4.4
27
        container_name: mongo
28
        hostname: mongo
29
        networks:
30
            - petio-network
31
        user: '1000:1000'
32
        volumes:
33
            - ./db:/data/db
Copied!
Once you configure the services, you need to spin up the container using docker-compose up -d.
Once the container is spun up, you can navigate to http://<hostname>:7777 to start configuring Petio.

FAQ

Next - Install Guides

Linux

Last modified 5mo ago

Copy link

Contents

Docker CLI

Docker Compose