Skip to content
OpenTickly

Auto-hospedagem

Rode o OpenTickly na sua própria máquina com Docker Compose. Um único comando sobe o app, o PostgreSQL e o Redis. Também cobre CasaOS, ZimaOS, Synology, fnOS e outras plataformas de NAS.

Para rodar o OpenTickly você mesmo, basta um arquivo docker-compose.yml. Veja abaixo como sair do zero até uma instância funcionando.

Requisitos do sistema

  • Qualquer máquina Linux, macOS ou Windows com Docker Engine 20.10+ e Docker Compose v2 instalados
  • Cerca de 1 GB de memória e 1 GB de espaço em disco
  • Uma porta TCP livre (padrão 8080)

Se ainda não tem o Docker, siga o guia oficial para instalá-lo antes de continuar.

Implantar o servidor

Passo 1 — Baixar o docker-compose.yml

Crie uma pasta nova e baixe o arquivo compose:

mkdir -p opentickly && cd opentickly

wget -O docker-compose.yml \
  https://raw.githubusercontent.com/CorrectRoadH/OpenTickly/main/docker-compose.yml

Ele sobe três containers:

  • OpenTickly — Interface web + REST API (exposto externamente na porta 8080)
  • postgres — Banco de dados (apenas na rede interna, não exposto)
  • redis — Cache e tarefas em segundo plano (apenas na rede interna, não exposto)

Passo 2 — (Opcional) Configurar o .env

Os valores padrão já funcionam. Para mudar a porta ou as senhas, crie um arquivo .env na mesma pasta:

# Porta externa da interface web e da API
OPENTOGGL_PORT=8080

# Troque por senhas fortes antes de usar para valer
OPENTOGGL_POSTGRES_PASSWORD=postgres
OPENTOGGL_REDIS_PASSWORD=opentoggl

Essas três são as únicas configurações que você pode mudar pelo .env. Todo o resto (nome do banco, usuário, imagens, strings de conexão) fica fixo no arquivo compose de propósito, para manter as instalações simples e parecidas entre si. Para mudar mais coisas, edite o docker-compose.yml diretamente.

Troque as duas senhas antes de usar para valer. Os valores padrão só servem para testar localmente. O Postgres e o Redis não ficam acessíveis de fora do Docker, mas se outra máquina ou outro container da sua rede for invadido, senhas fortes impedem que ele leia os seus dados.

Passo 3 — Iniciar os containers

docker compose up -d

Acessar a aplicação web

Abra http://<seu IP>:8080 no navegador, registre a primeira conta e já pode começar a registrar tempo.

Mobile

Ainda não há aplicativo para celular, mas você pode adicionar o app web à tela inicial do celular e usá-lo como um app (PWA). Também estamos conversando com desenvolvedores de apps de terceiros para o Toggl, como o Timery, sobre suporte ao OpenTickly.

Conectar agentes de IA

O OpenTickly não tem o limite de 30 requisições por hora do Toggl, então Claude, Cursor e outros agentes podem usá-lo o quanto precisarem. Configure o toggl-cli e, em poucos minutos, o seu agente já pode iniciar e parar o cronômetro e organizar projetos para você.

Atualização

docker compose pull
docker compose up -d

Implantar em NAS / Homelab

O OpenTickly roda em qualquer lugar que rode Docker Compose. Os passos abaixo são a mesma instalação, feita pela interface de cada plataforma.

CasaOS

  1. Abra o painel do CasaOS
  2. Vá em App Store → Instalação Personalizada → Importar docker-compose
  3. Cole o conteúdo do docker-compose.yml
  4. Ajuste a porta da Interface Web para 8080 e salve
  5. Inicie pelo painel

Acesse em http://<seu IP do CasaOS>:8080.

ZimaOS

O ZimaOS (sistema oficial do Zimablade / Zimacube) compartilha a mesma App Store do CasaOS, então os passos são idênticos: App Store → Instalação Personalizada → Importar docker-compose e cole o arquivo compose.

Synology

O Synology DSM 7.2+ suporta Docker Compose através do Container Manager:

  1. Abra Container Manager → Projeto → Criar
  2. Defina um nome de projeto, por exemplo opentickly
  3. Escolha Usar docker-compose.yml e cole o arquivo compose
  4. Avance pelo assistente até concluir

Se a porta 8080 entrar em conflito com o DSM, adicione OPENTOGGL_PORT=9090 (ou qualquer porta livre) nas configurações de ambiente antes de criar o projeto.

fnOS

O fnOS traz um painel Docker nativo:

  1. Abra o app Docker na área de trabalho do fnOS
  2. Na barra lateral esquerda, escolha Compose → Novo projeto
  3. Nome do projeto opentickly, mantenha o caminho de armazenamento padrão
  4. Em Conteúdo Compose, cole o arquivo compose
  5. Clique em Implantar e aguarde até que os três containers fiquem verdes

Outras plataformas

As plataformas abaixo seguem exatamente o mesmo fluxo de Docker Compose:

  • Unraid — via Community Applications ou plugin Compose Manager
  • TrueNAS SCALE — app personalizado + Docker Compose
  • Proxmox LXC — instale o Docker dentro de um container LXC e siga os passos de Implantar o servidor

Referência de configuração

Você pode mudar três configurações pelo .env:

VariávelPadrãoDescrição
OPENTOGGL_PORT8080Porta externa da interface web e da API
OPENTOGGL_POSTGRES_PASSWORDpostgresSenha do Postgres (obrigatório trocar em produção)
OPENTOGGL_REDIS_PASSWORDopentogglSenha do Redis (obrigatório trocar em produção)

Todo o resto (nome do banco, usuário, tags das imagens, strings de conexão, nomes de volume) é definido direto no docker-compose.yml. Para mudar, edite o arquivo.

Endpoints de health check

CaminhoFinalidade
/readyzPronto para atender? (verifica DB + Redis)
/healthzO processo está rodando?

Próximos passos

Configurar e-mail SMTP e SAML SSO

Configure o e-mail (para convites, recuperação de senha e verificação) e o login único via SAML em uma instância do OpenTickly auto-hospedada.

HTTPS e proxy reverso

Use Caddy ou Nginx para acessar o OpenTickly pelo seu endereço HTTPS.

On this page

Requisitos do sistemaImplantar o servidorPasso 1 — Baixar o docker-compose.ymlPasso 2 — (Opcional) Configurar o .envPasso 3 — Iniciar os containersAcessar a aplicação webMobileConectar agentes de IAAtualizaçãoImplantar em NAS / HomelabCasaOSZimaOSSynologyfnOSOutras plataformasReferência de configuraçãoEndpoints de health checkPróximos passos