Hozzáférés

Nyissa meg a böngészőjében: https://<SERVER_IP>
SSL figyelmeztetés elfogadása (önaláírt tanúsítvány).
Create a new account via the web interface.
Az első létrehozott fiók lesz az adminisztrátori felhasználó.

Konfiguráció

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

Szerkesztés .env vagy docker-compose.yml to apply changes:

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

Disable Public Signups (Optional)

Szerkesztés .env and modify DISABLE_SIGNUPS:

DISABLE_SIGNUPS=true

Változtatások alkalmazása:

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

Enable AI Features (Optional)

Szerkesztés /root/karakeep/docker-compose.yml under the web szolgáltatás:

environment:
  # OPENAI_API_KEY: "your_openai_api_key_here"

Uncomment the line and insert your OpenAI API key:

environment:
  OPENAI_API_KEY: "sk-xxxxxxxxxxxxxxxxxxxxxxxx"

Változtatások alkalmazása:

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

Fontos fájlok és könyvtárak

Alkalmazás könyvtár: /root/karakeep
Docker Compose fájl: /root/karakeep/docker-compose.yml
Környezeti fájl: /root/karakeep/.env
KaraKeep data: /var/lib/docker/volumes/karakeep_data/_data
Meilisearch data: /var/lib/docker/volumes/karakeep_meilisearch/_data
Nginx konfiguráció: /etc/nginx/sites-available/karakeep
SSL tanúsítványok: /etc/nginx/ssl/

Enabling SSL with a Domain (Optional)

1. Irányítsa domainjét a szerver IP-címére.

2. Szerkessze a /root/karakeep/docker-compose.yml fájl a domain név beállításához: NEXTAUTH_URL=https://your.domain.com

3. A szolgáltatások újbóli létrehozása:

cd /root/karakeep/
docker compose up -d

4. Szerkessze az Nginx konfigurációját, és cserélje ki mindkettőt server_name <IP>; a domainjével (<your-domain>) mind a HTTP (80-as port), mind a HTTPS (443-as port) blokkok esetében:

vim /etc/nginx/sites-available/karakeep

5. Telepítse a Certbotot:

apt install -y certbot python3-certbot-nginx

6. Futtassa a következő parancsot egy érvényes Let’s Encrypt tanúsítvány létrehozásához:

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

7. Cserélje ki az SSL útvonalakat az Nginx konfigurációban (TLS szakasz):

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. Indítsa újra az Nginx-et a változások alkalmazásához:

systemctl restart nginx

9. Nyissa meg a böngészőjét, és látogasson el a következő webhelyre: https://yourdomain.com

Karakeep

Az alkalmazás részletei