66 lines
1.8 KiB
Markdown
66 lines
1.8 KiB
Markdown
# noz-studio
|
|
|
|
A web editor PWA for [noz](https://github.com/noz-lab/noz) — write and manage notes from any device, even without the CLI.
|
|
|
|
> **Personal use.** Built as part of my own noz setup — open source, but things change without notice.
|
|
|
|
## Features
|
|
|
|
- **CodeMirror 6** editor with Markdown syntax highlighting
|
|
- **Live preview** — rendered note side by side with the editor
|
|
- **Wikilinks** — `[[Note Title]]` autocomplete and resolution
|
|
- **Diagram canvas** — visual editor for `_diagram.toml` folder diagrams
|
|
- **Full-text search** — search your garden from the sidebar
|
|
- **PWA** — installable, works offline for reading cached notes
|
|
- **Dark / light mode**
|
|
- **Multilingual** (de / en)
|
|
|
|
## Setup
|
|
|
|
noz-studio connects to a running noz instance via the CLI API. You need a token configured in your noz server's `.env.local`:
|
|
|
|
```
|
|
NOZ_CLI_TOKEN=your-secret-token
|
|
```
|
|
|
|
And in `noosphere.toml`:
|
|
|
|
```toml
|
|
[studio]
|
|
auth = "token" # or "authentik" or "both"
|
|
allow_push = true
|
|
```
|
|
|
|
Then set the allowed origin for CORS in `.env.local` on your noz server:
|
|
|
|
```
|
|
NOZ_STUDIO_ORIGIN=https://studio.your-domain.com
|
|
```
|
|
|
|
## Running locally
|
|
|
|
```bash
|
|
pnpm install
|
|
pnpm dev # starts on port 3001
|
|
```
|
|
|
|
Open `http://localhost:3001`, enter your noz server URL and token.
|
|
|
|
For local development, you can prefill credentials via environment variables:
|
|
|
|
```
|
|
NEXT_PUBLIC_DEV_SERVER=http://localhost:3000
|
|
NEXT_PUBLIC_DEV_TOKEN=your-token
|
|
```
|
|
|
|
## Deployment
|
|
|
|
noz-studio is a standard Next.js app — deploy anywhere Next.js runs (Vercel, Docker, self-hosted).
|
|
|
|
The `infra/` folder in [noz](https://github.com/noz-lab/noz) contains a Traefik config for self-hosting behind a reverse proxy.
|
|
|
|
## License
|
|
|
|
[AGPL-3.0-only](LICENSE)
|
|
|
|
For commercial licensing (proprietary use without copyleft), open an issue.
|