Skip to content
/ zorka Public

free and fast self-hosted url shortener

License

Notifications You must be signed in to change notification settings

litvinav/zorka

Repository files navigation

logo

⭐ Zorka (Cyrillic: зорка, [ˈzorkə], star in Belarusian) is a fast, self contained and minimalistic url shortener, using Actix to store and host the redirects.

You can read up on the usage of this tool in docs/en/_readme.md.

In the case you just want to try this project out, get a prebuild docker image from litvinav/zorka and run it with a exposed port 8080 or a port number specified via the PORT environment variable.

Minimal example

services:
  zorka:
    image: litvinav/zorka:v0.4.0
    ports:
    - 8080:8080
    volumes:
    - ./seed.csv:/app/seed.csv # first startup seeding; ignore for empty launch
    - backups:/app/backups     # internal backups on exit; ignore for emphemeral storage
    - ./configuration.yaml:/app/configuration.yaml # configuration override; ignore for default
    deploy:
      restart_policy:
        condition: on-failure
        delay: 5s
        max_attempts: 3
        window: 120s
      # start with these resources and scale vertically, if required
      resources:
        limits:
          cpus: '0.15'
          memory: 30M
    cap_drop: [ALL]
volumes:
  backups: {}