Configuração
O Notarium é configurado por variáveis de ambiente — nenhum segredo ou caminho fica embutido na imagem. Os padrões são pensados para zero-config: uma instância nova sobe sem nenhuma configuração. Esta página é uma visão geral das variáveis principais; a lista completa, com valores exatos e padrões, está na Referência.
A configuração é definida com flags -e no docker run ou por um arquivo .env (copiado de .env.example). O stack Docker repassa o .env para o contêiner como está.
Variáveis principais
| Variável | Finalidade | Padrão |
|---|---|---|
DATA_DIR | O único ajuste de dados: a raiz da qual todo o resto é derivado — banco de metadados, índices, notas, artefatos. Não definida → usa-se um padrão funcional. | /data (Docker); ~/.local/share/notarium (host) |
PORT | A porta em que o backend escuta (/api, /mcp e a interface web). | 3000 |
AUTH_MODE | Modo de autenticação: password ou none. | password |
META_DB_URL | Banco de metadados: sqlite:<path> ou postgres://…. Opcional — defina apenas para um Postgres externo; por padrão, é um SQLite dentro de DATA_DIR. | sqlite:<DATA_DIR>/meta.db |
SPACES_ROOT | A raiz onde cada espaço é uma pasta; habilita a criação de espaços pela interface. Opcional — só se as notas ficarem fora de DATA_DIR. | <DATA_DIR>/spaces |
VECTOR_SEARCH | on/off — busca semântica (vetorial). | off na imagem publicada (on no código) |
Cada tema é detalhado em sua própria página: Autenticação (AUTH_MODE), Banco de dados (META_DB_URL), Busca semântica (VECTOR_SEARCH e os parâmetros do modelo).
Topologia de espaços
Há duas maneiras de definir espaços:
SPACES_ROOT— zero-config: cada espaço é uma pasta sob a raiz informada. Os espaços são criados na primeira execução e pelo botão "New space…" na interface. Este é o padrão do stack Docker.SPACES_CONFIG— uma topologia explícita e fixa (JSON inline ou o caminho para um arquivo JSON). Boa opção quando o conjunto de espaços é definido pelo operador e não é criado pela interface.
Para entender o modelo de espaços e projetos, consulte Conceitos.
Autenticação de agentes (OAuth)
Além dos tokens pessoais (PATs), o Notarium pode autorizar conectores MCP via OAuth — assim um agente (o conector do Claude, por exemplo) se autentica sozinho, sem token para colar à mão. Isso não exige configuração à parte: os clientes se registram dinamicamente. Atrás de um proxy reverso, defina PUBLIC_BASE_URL (por exemplo, https://notes.example.com) — um endereço externo estável para os metadados OAuth; sem ele, o endereço é derivado dos cabeçalhos encaminhados pelo proxy. Atrás de um proxy, também vale definir TRUST_PROXY, para que os limites de login e de admissão de novos conectores sejam contados pelo IP real do cliente, e não pelo endereço do proxy — veja Produção. Para saber mais sobre como conectar agentes, veja Conectar um agente.
As variáveis de busca (EMBED_MODEL, EMBED_DIMENSIONS, EMBED_CPU_MEM_ARENA e outras), os tempos de sincronização e demais controles de ajuste fino estão reunidos nas tabelas da página Variáveis de ambiente.
A seguir: configure a autenticação e, se necessário, a busca semântica.