sij/khoj
1
0
Fork 0
mirror of https://github.com/khoj-ai/khoj.git synced 2024-11-23 15:38:55 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 5
khoj/documentation/docs/advanced/tailscale.md

2.3 KiB
Raw Permalink Blame History

Tailscale

:::info This is only helpful for secure cross-device access to self-hosted Khoj. You do not need this if you're using Khoj Cloud. :::

Tailscale simplifies creating a private VPN using Wireguard and OAuth. So you can host and access services on your devices from anywhere. The instructions below are one way to simply and securely access your self-hosted Khoj from your phone, laptop etc.

Minimal Setup

  1. Setup khoj on your preferred machine following the standard steps
  2. Sign-up to Tailscale and install the app on machines you want to access Khoj from. This usually includes your khoj server, your phone, laptop. Note the tailscale i.p of your khoj server.
  3. Start khoj on your server by including the flag --host <your_server_tailscale_ip>
  4. Open http://<your_server_tailscale_ip>:42110 to access khoj from any device on your tailscale network!

HTTPS Certificate

:::info Tailscale uses Wireguard to encrypt and route traffic between your machines. So HTTPS isn't required with Tailscale for secure access. HTTPS with Tailscale is only useful for browsers to not complain about security and block certain features like clipboard access unless HTTPS is enabled. :::

  1. Enable MagicDNS and HTTPS toggle on your tailscale admin console DNS page. Note your unique tailscale domain name (usually ends with .ts.net)
  2. Create an https certificate for your Khoj server by running the following command: 
    # Assuming the server is named, `server` and your tailnet is `black-forest.ts.net`
# Note path of the .crt and .key files generated

tailscale cert server.black-forest.ts.net
  3. Start khoj to be served via https on standard port 
    sudo KHOJ_DOMAIN=server.black-forest.ts.net \
khoj \
--sslcert /path/to/your/tailscale.crt \
--sslkey path/to/your/tailscale.key \
--host=server.black-forest.ts.net \
--port 443
  4. You should now be able to access khoj on https://server.black-forest.ts.net from any device on your private tailscale network!