Adgang

Åbn i din browser: https://<SERVER_IP>
Accepter SSL-advarsel (selvsigneret certifikat).
Create a new account via the web interface.
Den første oprettede konto bliver administratorbrugeren.

Konfiguration

Environment variables are stored in: /root/karakeep/.env

Rediger .env eller docker-compose.yml to apply changes:

docker compose -f /root/karakeep/docker-compose.yml up -d

Disable Public Signups (Optional)

Rediger .env and modify DISABLE_SIGNUPS:

DISABLE_SIGNUPS=true

Anvend ændringer:

docker compose -f /root/karakeep/docker-compose.yml up -d

Enable AI Features (Optional)

Rediger /root/karakeep/docker-compose.yml under the web service:

environment:
  # OPENAI_API_KEY: "your_openai_api_key_here"

Uncomment the line and insert your OpenAI API key:

environment:
  OPENAI_API_KEY: "sk-xxxxxxxxxxxxxxxxxxxxxxxx"

Anvend ændringer:

docker compose -f /root/karakeep/docker-compose.yml up -d

Vigtige filer og mapper

Applikationskatalog: /root/karakeep
Docker Compose-fil: /root/karakeep/docker-compose.yml
Miljøfil: /root/karakeep/.env
KaraKeep data: /var/lib/docker/volumes/karakeep_data/_data
Meilisearch data: /var/lib/docker/volumes/karakeep_meilisearch/_data
Nginx-konfiguration: /etc/nginx/sites-available/karakeep
SSL-certifikater: /etc/nginx/ssl/

Enabling SSL with a Domain (Optional)

1. Peg dit domæne mod serverens IP-adresse.

2. Rediger /root/karakeep/docker-compose.yml fil for at indstille dit domænenavn: NEXTAUTH_URL=https://your.domain.com

3. Genskab tjenesterne:

cd /root/karakeep/
docker compose up -d

4. Rediger Nginx-konfigurationen og udskift begge dele server_name <IP>; med dit domæne (<your-domain>) for både HTTP (port 80) og HTTPS (port 443) blokeringer:

vim /etc/nginx/sites-available/karakeep

5. Installer Certbot:

apt install -y certbot python3-certbot-nginx

6. Kør følgende kommando for at generere et gyldigt Let’s Encrypt-certifikat:

certbot certonly --nginx --non-interactive --agree-tos --email [email protected] -d yourdomain.com

7. Erstat SSL-stier i Nginx-konfigurationen (TLS-sektionen):

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. Genstart Nginx for at anvende ændringerne:

systemctl restart nginx

9. Åbn din browser og gå til: https://yourdomain.com

Karakeep

Ansøgningsoplysninger