Documentation / v0.3.0
A little guidance.
A lot of possibility.
Get your first workspace running, find a workflow that fits, or build on the API. Everything you need to understand the self-hosted platform, in one place.
Start here
- Get started with Hopya
Install a private Hopya instance, create your first workspace, and understand the next steps for teams and operators.
Use Hopya
- Using Hopya
Learn workspaces, tasks, five views, Documents, Tables, collaboration, and account settings.
- Private images and draft recovery
Upload images to task bodies and discussions, recover drafts, and understand private access and cleanup.
- Profile pictures
Add a private profile picture and understand formats, limits, visibility, and account-photo APIs.
- Appearance and resource icons
Customize resource icons and colors, and manage instance-wide sidebar attribution.
Use cases
- Plan work with your team
Build a shared project workflow with lists, assignees, checklists, status views, discussions, and deliberate review.
- Connect notes and structured data
Keep project context in Documents, structured records in Tables, and actionable work in task Lists without confusing their roles.
- Move work with CSV and JSON
Plan a bounded, verified migration of task and Table records from spreadsheets or another tool without claiming one-click compatibility.
API
- API quick start
Authenticate with a personal token, discover authorized workspaces, follow task cursors, and handle safe versioned writes.
- REST API reference
Endpoint contracts for authentication, tasks, Documents, Tables, roles, imports, webhooks, and automation graphs.
Operate
- Self-hosting and deployment
Deploy Hopya with Docker, configure HTTPS and storage, rehearse backups, and upgrade safely.
- Security and privacy
Understand authentication, workspace permissions, private storage, integration risks, and operator responsibilities.
- Optional integrations
Configure AI, MCP, OIDC, filesystem or S3-compatible storage without making them core dependencies.
- OpenID Connect sign-in
Connect an OIDC provider with PKCE, exact issuer/subject bindings, controlled enrollment, and recovery planning.
Under the hood
- Architecture and integration contract
Explore the AdonisJS API boundary, Astro/React workspace, database snapshots, hierarchy, and integration contracts.
- Effect integration workflows
Understand bounded integration execution, interruption, resource ownership, and fail-closed recovery.
Evaluating another tool? Read the comparisons.
Prefer a hand with hosting or deployment? Talk to WNZN.