Acesso
- Abra no seu navegador:
https://<SERVER_IP> - Aceitar aviso SSL (certificado autoassinado).
- Create a new account via the web interface.
- A primeira conta criada torna-se o utilizador administrador.
Configuração
Environment variables are stored in: /root/karakeep/.env
Editar .env ou docker-compose.yml to apply changes:
docker compose -f /root/karakeep/docker-compose.yml up -d
Disable Public Signups (Optional)
Editar .env and modify DISABLE_SIGNUPS:
DISABLE_SIGNUPS=true
Aplicar alterações:
docker compose -f /root/karakeep/docker-compose.yml up -d
Enable AI Features (Optional)
Editar /root/karakeep/docker-compose.yml under the web serviço:
environment:
# OPENAI_API_KEY: "your_openai_api_key_here"
Uncomment the line and insert your OpenAI API key:
environment:
OPENAI_API_KEY: "sk-xxxxxxxxxxxxxxxxxxxxxxxx"
Aplicar alterações:
docker compose -f /root/karakeep/docker-compose.yml up -d
Ficheiros e diretórios importantes
- Diretório da aplicação:
/root/karakeep - Ficheiro Docker Compose:
/root/karakeep/docker-compose.yml - Arquivo de ambiente:
/root/karakeep/.env - KaraKeep data:
/var/lib/docker/volumes/karakeep_data/_data - Meilisearch data:
/var/lib/docker/volumes/karakeep_meilisearch/_data - Configuração do Nginx:
/etc/nginx/sites-available/karakeep - Certificados SSL:
/etc/nginx/ssl/
Enabling SSL with a Domain (Optional)
1. Direcione o seu domínio para o IP do servidor.
2. Edite o /root/karakeep/docker-compose.yml para definir o seu nome de domínio: NEXTAUTH_URL=https://your.domain.com
3. Recrie os serviços:
cd /root/karakeep/
docker compose up -d
4. Edite a configuração do Nginx e substitua ambos server_name <IP>; com o seu domínio (<your-domain>) para blocos HTTP (porta 80) e HTTPS (porta 443):
vim /etc/nginx/sites-available/karakeep
5. Instale o 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. Substitua os caminhos SSL na configuração do Nginx (secçã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. Reinicie o Nginx para aplicar as alterações:
systemctl restart nginx
9. Abra o seu navegador e aceda a: https://yourdomain.com