README.md

This docker image allows you to quickly and easily run Utopia client with the configured API and start working right away.

• Ready image: uto9234/utopia-api from docker hub.
• Forum thread.

Contents

• How to run a container
• How to connect to API
• Example of using docker-compose

Requirements

• Docker 2.2+
• 2+ gb RAM
• 1.4 gb free space.

How to run a container

Create your first Utopia container from image:

docker pull uto9234/utopia-api
docker run --name utopia --memory=1024m --memory-reservation=256m --restart=always -it uto9234/utopia-api

NOTE: --memory=1024m - optional parameter to set max RAM for container to 1gb. --memory-reservation=200m - min RAM for container

or create container without running it:

docker create --name utopia --memory=1024m --memory-reservation=256m uto9234/utopia-api

also you can add optional param --restart=always to auto-restart container.

run existing container:

docker container start utopia

How to build image

git clone https://github.com/Sagleft/utopia-api-docker && cd utopia-api-docker
docker build . --tag utopia-api

Utopia API

The first time you start the container, a new account file will be created.

The following parameters are available to work with the API:

• API port: 22825
• API websocket port: 25000
• API protocol: http
• API token: FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF

Alternative to using docker image: use the simple U for Ubuntu installation script

If you want to use an existing account

Then build the image, change the config file, and then put the account file inside the container.

Step 1: build the image & create a container:

docker build -t utopia .
docker create --name utopia --memory=1024m --memory-reservation=256m uto9234/utopia-api

Step 2: update utopia.cfg: set account password. By default: password.

Step 3: copy account to container:

docker cp ./account.db utopia:/app/account.db

where:

• ./account.db - the path to the account on the machine. in this example, the path to the file in the current folder;
• utopia - image name.

NOTE: it is recommended to clear the account file before using it if it was actively used in the GUI client before. This can be done through the menu item "File" -> "Export Database..."

how to prevent log memory shortages

make the following changes to the file /etc/docker/daemon.json:

{
  "log-driver": "json-file",
  "log-opts": {
    "max-size": "100m",
    "max-file": "3"
  }
}

then restart docker daemon to apply changes

systemctl restart docker

or you can setup cron:

*/5 * * * * truncate -s 1m /var/lib/docker/containers/*/*-json.log

Example of using docker-compose.yml

version: "2.2"

services:
  bot: # an example of your service that will be built from a Docker file
    build: src/     # path to Docker file
    restart: always # Restart when crashed
    depends_on:
      - utopia-api
    networks:
      - unetwork
    environment:
      UTOPIA_HOST: utopia-api                        #--------------------------------#
      UTOPIA_TOKEN: FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF #       Passing connection       #
      UTOPIA_PORT: 22825                             # parameters to your application #
      UTOPIA_WS_PORT: 25000                          #--------------------------------#
    logging:
      driver: "json-file" #---------------------#
      options:            # Limiting the number #
        max-size: "10m"   #   and size of logs  #
        max-file: "3"     #---------------------#

  utopia-api:
    image: uto9234/utopia-api # container
    restart: always           # Restart when crashed
    ports:
      - 22825:22825 # API http port
      - 25000:25000 # API websocket port
    environment:
      XDG_RUNTIME_DIR: /tmp/runtime-root  # To avoid displaying a warning at startup
    networks:
      - unetwork
    volumes:                              # This allows you to set a specific path to an existing
      - ./data/account.db:/app/account.db # account file. You can delete this to create new account
    logging:
      driver: "json-file"
      options:
        max-size: "10m"
        max-file: "3"

networks:
  unetwork:

useful links