Getting Started

Everything you need to build with the Heffos platform.

Quickstart

Heffos runs on a Linux server you control. Getting your first workspace up takes four steps.

  1. Create your account at app.heffos.com and choose your workspace address.
  2. Copy the one-time install token and run the install command on a fresh Linux server.
  3. Choose the admin password when the installer asks. It stays on your server — we never see it.
  4. Open your workspace at your-team.heffos.com, switch on the tools you need and invite your team.

Migration

Heffos imports from the tools you already use. Each import keeps a record of what came from where, so it can run again without creating duplicates.

  • Jira and Confluence — projects, issues, spaces and pages, set up in the admin area.
  • Pipedrive — organisations, people, deals and activities into the CRM, one way and incrementally.
  • Google Workspace — your user directory, through the staged user-import wizard.
  • Google Drive — a scheduled import into Drive.
  • MantisBT — cases and their history into Desk.
  • GitHub and GitLab — repositories into your workspace’s GitLab.

Self-hosting

On the host, Heffos runs a single process of its own — the Heffos agent. Everything else runs in Docker.

Each workspace is its own stack, with its own PostgreSQL database and one directory on disk. One server can host several workspaces, and each keeps its own version.

  • To add a workspace to a server that already runs one, run the install command again with a new token. The existing workspaces are left untouched.
  • Use your own domain, or the address Heffos gives you: your-team.heffos.com.
  • Your data lives on your server, so backups are yours to keep: back up the workspace directory and its database.

API

Every workspace serves a REST API under /api/v1. For scripts and integrations, create a personal API token and give it only the scopes it needs.

Security

  • A separate PostgreSQL database for every workspace.
  • Passwords hashed with Argon2id; short-lived access tokens with refresh-token rotation.
  • Roles — owner, admin, member and guest — plus per-module access and permission schemes.
  • Page restrictions in the Wiki and per-record restrictions in the CRM.

Updates

Heffos is published as signed packages in the Heffos apt repository, and your server checks every signature before it installs anything.

Updating one workspace never changes another: two workspaces on the same server can run different versions. To stay on a version, hold the package with apt-mark hold heffos-platform.

FAQ

Short answers to common questions are on the support page.