Access
- Abra no navegador:
https://<SERVER_IP> - Aceite o aviso de SSL (certificado autoassinado).
- Crie uma nova conta pela interface web.
- A primeira conta criada torna-se o usuário administrador.
Configuration
As variáveis de ambiente estão em: /root/karakeep/.env
Edit .env or docker-compose.yml to apply changes:
docker compose -f /root/karakeep/docker-compose.yml up -d
Desativar cadastros públicos (opcional)
Edit .env and modify DISABLE_SIGNUPS:
DISABLE_SIGNUPS=true
Apply changes:
docker compose -f /root/karakeep/docker-compose.yml up -d
Ativar recursos de IA (opcional)
Edit /root/karakeep/docker-compose.yml under the web service:
environment:
# OPENAI_API_KEY: "your_openai_api_key_here"
Descomente a linha e insira sua chave API da OpenAI:
environment:
OPENAI_API_KEY: "sk-xxxxxxxxxxxxxxxxxxxxxxxx"
Apply changes:
docker compose -f /root/karakeep/docker-compose.yml up -d
Arquivos e Diretórios Importantes
- Application directory:
/root/karakeep - Arquivo Docker Compose:
/root/karakeep/docker-compose.yml - Environment file:
/root/karakeep/.env - KaraKeep data:
/var/lib/docker/volumes/karakeep_data/_data - Meilisearch data:
/var/lib/docker/volumes/karakeep_meilisearch/_data - Nginx configuration:
/etc/nginx/sites-available/karakeep - SSL certificates:
/etc/nginx/ssl/
Ativar SSL com um Domínio (Opcional)
1. Aponte seu domínio para o IP do servidor.
2. Edit the /root/karakeep/docker-compose.yml para definir o nome do seu domínio: NEXTAUTH_URL=https://your.domain.com
3. Recriar os serviços:
cd /root/karakeep/
docker compose up -d
4. Editar a configuração do Nginx e substituir ambos server_name <IP>; pelo seu domínio (<your-domain>) nos blocos de HTTP (porta 80) e HTTPS (porta 443):
vim /etc/nginx/sites-available/karakeep
5. Install Certbot:
apt install -y certbot python3-certbot-nginx
6. Execute o seguinte comando para gerar um certificado Let's Encrypt válido:
certbot certonly --nginx --non-interactive --agree-tos --email [email protected] -d yourdomain.com
7. Substituir os caminhos SSL na configuração do Nginx (seção TLS):
vim /etc/nginx/sites-available/karakeep
# Before:
# ssl_certificate /etc/nginx/ssl/fullchain.pem;
# ssl_certificate_key /etc/nginx/ssl/privkey.pem;
# After:
# ssl_certificate /etc/letsencrypt/live/yourdomain.com/fullchain.pem;
# ssl_certificate_key /etc/letsencrypt/live/yourdomain.com/privkey.pem;
8. Reiniciar o Nginx para aplicar as alterações:
systemctl restart nginx
9. Abra o navegador e acesse: https://yourdomain.com
