mirror of
https://github.com/khoj-ai/khoj.git
synced 2026-01-24 14:08:16 -05:00
- Improve Self Hosting Docker Instructions
- Ask to Install Docker Desktop to not require separate
docker-compose install and unify the instruction across OS
- To Self Host on Windows, ask to use Docker Desktop with WSL2 backend
- Use nested Tab grouping to split Docker vs Pip Self Host Instructions
- Reduce Self Host Setup Steps in Documentation after code simplification
- First run now avoids need to configure Khoj via admin panel
- So move the chat model config steps into optional post setup
config section
- Improve Instructions to Configure chat models on First Run
- Compress configuring chat model providers into a Tab Group
- Add Documentation for Remote Access under Advanced Self Hosting
1.5 KiB
1.5 KiB
Remote Access
By default self-hosted Khoj is only accessible on the machine it is running. To securely access it from a remote machine:
- Set the
KHOJ_DOMAINenvironment variable to your remotely accessible ip or domain via shell or docker-compose.yml. Examples:KHOJ_DOMAIN=my.khoj-domain.com,KHOJ_DOMAIN=192.168.0.4. - Ensure the Khoj Admin password and
KHOJ_DJANGO_SECRET_KEYenvironment variable are securely set. - Setup Authentication.
- Open access to the Khoj port (default: 42110) from your OS and Network firewall.
:::warning[Use HTTPS certificate] To expose Khoj on a custom domain over the public internet, use of an SSL certificate is strongly recommended. You can use Let's Encrypt to get a free SSL certificate for your domain.
To disable HTTPS, set the KHOJ_NO_HTTPS environment variable to True. This can be useful if Khoj is only accessible behind a secure, private network.
:::
:::info[Try Tailscale] You can use Tailscale for easy, secure access to your self-hosted Khoj over the network.
- Set
KHOJ_DOMAINto your machines tailscale ip or fqdn on tailnet. E.gKHOJ_DOMAIN=100.4.2.0orKHOJ_DOMAIN=khoj.tailfe8c.ts.net - Access Khoj by opening
http://tailscale-ip-of-server:42110orhttp://fqdn-of-server:42110from any device on your tailscale network :::