elyby/chrly repository overview

⁠Supported tags and respective Dockerfile links

• edge⁠
• 4.6.0, latest⁠
• 4.5.0⁠
• 4.4.1⁠

⁠Quick reference

• Where to file issues: https://github.com/elyby/chrly/issues⁠

• Maintained by: the Ely.by team⁠

• Supported architectures: amd64

⁠What is Chrly?

Chrly is a lightweight implementation of Minecraft skins system server. It's packaged and distributed as a Docker image and can be downloaded from Dockerhub⁠. App is written in Go, can withstand heavy loads and is production ready.

⁠Installation

You can easily install Chrly using docker-compose⁠. The configuration below (save it as docker-compose.yml) can be used to start a Chrly server. It relies on CHRLY_SECRET environment variable that you must set before running docker-compose up -d. Other possible variables are described below.

version: '2'
services:
  app:
    image: elyby/chrly
    hostname: chrly0
    restart: always
    links:
      - redis
    volumes:
      - ./data/capes:/data/capes
    ports:
      - "80:80"
    environment:
      CHRLY_SECRET: replace_this_value_in_production

  redis:
    image: redis:4.0-32bit
    restart: always
    volumes:
      - ./data/redis:/data

Chrly will mount some volumes on the host machine to persist storage for capes and Redis database.

⁠Config

Application's configuration is based on the environment variables. You can adjust config by modifying environment key inside your docker-compose.yml file. After value will have been changed, container should be stopped and recreated. If environment variables have been changed, Docker will automatically recreate the container, so you only need to stop and up it:

docker-compose stop app
docker-compose up -d app

Variables to adjust:

If something goes wrong, you can always access logs by executing docker-compose logs -f app.