Skip to content

docs: add configuration section#6

Merged
juliusknorr merged 12 commits into
mainfrom
docs/configuration
Jun 26, 2026
Merged

docs: add configuration section#6
juliusknorr merged 12 commits into
mainfrom
docs/configuration

Conversation

@juliusknorr

Copy link
Copy Markdown
Member

Adds a Configuration section to the docs:

  • Server configuration (local.json model + Docker environment variables)
  • Custom fonts
  • Installing plugins
  • Logging
  • Command-line tools

Values verified against the server and DocumentServer repositories. Linked from the start page, Docker install page, and the integration plugin list.

Add a Configuration section with a custom fonts page covering bare-metal
and Docker, linked from the nav and start page.

Assisted-by: ClaudeCode:claude-opus-4-8
Signed-off-by: Julius Knorr <jus@bitgrid.net>
Document the local.json model (deb/rpm) and the Docker environment
variables, with the verified config key paths each one maps to. Link
the Docker install page to the full reference.

Assisted-by: ClaudeCode:claude-opus-4-8
Signed-off-by: Julius Knorr <jus@bitgrid.net>
The standalone Docker image only accepts DB_TYPE=postgres; other engines
require the cluster image. Verified against the entrypoint in DocumentServer.

Assisted-by: ClaudeCode:claude-opus-4-8
Signed-off-by: Julius Knorr <jus@bitgrid.net>
Document installing editor plugins into sdkjs-plugins via
documentserver-pluginsmanager.sh for package and Docker installs, and
cross-link the integration plugin list. Verified against DocumentServer.

Assisted-by: ClaudeCode:claude-opus-4-8
Signed-off-by: Julius Knorr <jus@bitgrid.net>
Document the documentserver-* admin scripts (configure, jwt-status,
flush-cache, securelink, static-gzip, prepare4shutdown, letsencrypt)
for package and Docker installs. Verified against DocumentServer.

Assisted-by: ClaudeCode:claude-opus-4-8
Signed-off-by: Julius Knorr <jus@bitgrid.net>
Document log4js log levels via production.json and the DS_LOG_LEVEL
Docker variable, plus per-service log file locations. Verified against
DocumentServer.

Assisted-by: ClaudeCode:claude-opus-4-8
Signed-off-by: Julius Knorr <jus@bitgrid.net>
Replace the start page cards with one per top-level section
(Introduction, Installation, Configuration, Integration, Development)
and drop the now-redundant list.

Assisted-by: ClaudeCode:claude-opus-4-8
Signed-off-by: Julius Knorr <jus@bitgrid.net>
Cover finding plugins from the upstream sdkjs-plugins collection, mounting
plugins in Docker, the in-editor plugin manager, and plugin removal.

Signed-off-by: Julius Knorr <jus@bitgrid.net>
Assisted-by: ClaudeCode:claude-opus-4-8
@juliusknorr juliusknorr marked this pull request as ready for review June 23, 2026 20:15
Signed-off-by: Julius Knorr <jus@bitgrid.net>
Assisted-by: ClaudeCode:claude-opus-4-8
Signed-off-by: Julius Knorr <jus@bitgrid.net>
Signed-off-by: Julius Knorr <jus@bitgrid.net>
Assisted-by: ClaudeCode:claude-opus-4-8
Signed-off-by: Julius Knorr <jus@bitgrid.net>
@juliusknorr juliusknorr moved this from 📄 To do to 👀 In review in 📄 Euro-Office team Jun 24, 2026
@juliusknorr juliusknorr self-assigned this Jun 24, 2026
…lanation

Replace placeholder `your-secret` and `dev-secret` with a working example

(`at-least-32-chars-long-for-hs256`) across all configuration and Docker

examples. The placeholder `your-secret` (12 chars) would fail the HS256

32-char minimum enforced by the document server's JWT implementation.

- Add explanation of the 32-char minimum requirement in server.md

- Add `openssl rand -hex 32` command for generating valid secrets

- Add 32-char warning to server.md and Nextcloud integration guide

- Update all `your-secret` and `dev-secret` examples in Docker commands

Assisted-by: OpenCode:qwen3.6-27b
Signed-off-by: Christoph Schaefer <christoph.schaefer@nextcloud.com>

@chrip chrip left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Replaced your-secret and dev-secret with a valid 32-char example across all docs.
One note: Paths like log directories differ on branded builds (e.g., /var/log/nextcloud-office/ vs /var/log/euro-office/). We should probably add a brief note in the logging or configuration guide. And we have to remember that, if we merge parts of this doc into the nextcloud docs.

@juliusknorr

Copy link
Copy Markdown
Member Author

Thanks, will push a commit to adapt this to be brandable. I had some logic in place here already.

Branded builds use a different on-disk namespace (e.g. nextcloud-office),
so replace the hardcoded euro-office token in install/config/log paths,
the package name, and example container names with a new
{{ brand.package_path_name }} macro.

Signed-off-by: Julius Knorr <jus@bitgrid.net>
Assisted-by: ClaudeCode:claude-opus-4-8
@juliusknorr juliusknorr merged commit 1cee1a9 into main Jun 26, 2026
2 checks passed
@github-project-automation github-project-automation Bot moved this from 👀 In review to ☑️ Done in 📄 Euro-Office team Jun 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: ☑️ Done

Development

Successfully merging this pull request may close these issues.

2 participants