AI for selfhost

[forehalo]

There are too many questions regarding AFFiNE AI support for selfhost instances and some of them are outdated.
Let's make this one as the official QA and progress tracking for all the concerns.
I will pin this on top of issues panel, the old ones or new comings will be closed directly and leave a ref to this issue.

Progress

• unbind actions with specified models
• support my own keys in admin panel
• support custom providers(ollama, deepseek, ...)
• more...

[forehalo]

Can I enable the AI in an unofficial way now in my instance?

The answer is yes.

Steps for those using provided compose file:

1. create a JSON config at ${CONFIG_LOCATION}/config.json

If you are using an editor that supports JSON lsp, the "$schema" field with provide you fully commented fields auto-complete

{
  "$schema": "https://github.com/toeverything/affine/releases/latest/download/config.schema.json",
  "copilot": {
    "enabled": true,
    "providers.openai": {
      "apiKey": "your key",
      "baseUrl": "open-ai-compatitable.example.com"
    }
  }
}

2. restart your host

docker compose up -d

Steps for custom deployment:

1. create a JSON config

{
  "$schema": "https://github.com/toeverything/affine/releases/latest/download/config.schema.json",
  "copilot": {
    "enabled": true,
    "providers.openai": {
      "apiKey": "your key",
    }
  }
}

2. Mount or Copy the config file to your instance

3. import the config

node --import ./scripts/register.js ./dist/data/index.js import-config ./path/to/config.json

4. restart your host