카라킵

데이터와 즐겨찾기를 저장하고 정리하며 관리할 수 있는 앱입니다.

접근

  • 브라우저에서 열기: https://<SERVER_IP>
  • SSL 경고(자체 서명 인증서) 수락
  • Create a new account via the web interface.
  • 최초로 생성된 계정이 관리자 사용자가 됩니다.

구성

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

편집 .env 또는 docker-compose.yml to apply changes:

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

Disable Public Signups (Optional)

편집 .env and modify DISABLE_SIGNUPS:

DISABLE_SIGNUPS=true

변경 사항 적용:

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

Enable AI Features (Optional)

편집 /root/karakeep/docker-compose.yml under the web 서비스:

environment:
  # OPENAI_API_KEY: "your_openai_api_key_here"

Uncomment the line and insert your OpenAI API key:

environment:
  OPENAI_API_KEY: "sk-xxxxxxxxxxxxxxxxxxxxxxxx"

변경 사항 적용:

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

중요한 파일 및 디렉터리

  • 응용 프로그램 디렉터리: /root/karakeep
  • Docker Compose 파일: /root/karakeep/docker-compose.yml
  • 환경 파일: /root/karakeep/.env
  • KaraKeep data: /var/lib/docker/volumes/karakeep_data/_data
  • Meilisearch data: /var/lib/docker/volumes/karakeep_meilisearch/_data
  • Nginx 구성: /etc/nginx/sites-available/karakeep
  • SSL 인증서: /etc/nginx/ssl/

Enabling SSL with a Domain (Optional)

1. 도메인을 서버 IP로 연결하십시오.

2. 편집 /root/karakeep/docker-compose.yml 도메인 이름을 설정하는 파일: NEXTAUTH_URL=https://your.domain.com

3. 서비스를 재구축하십시오:

cd /root/karakeep/
docker compose up -d

4. Nginx 구성 파일을 편집하고 두 개 모두를 교체하십시오. server_name <IP>; 귀하의 도메인과 함께 (<your-domain>HTTP(포트 80) 및 HTTPS(포트 443) 블록 모두에 대해:

vim /etc/nginx/sites-available/karakeep

5. Certbot 설치:

apt install -y certbot python3-certbot-nginx

6. 유효한 Let’s Encrypt 인증서를 생성하려면 다음 명령어를 실행하십시오:

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

7. Nginx 구성 파일(TLS 섹션)에서 SSL 경로 교체:

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. 변경 사항을 적용하려면 Nginx를 재시작하십시오:

systemctl restart nginx

9. 브라우저를 열고 다음 주소를 방문하세요: https://yourdomain.com

신청 세부사항