Dashboard

Getting started

How HCode works

Organisations, projects, deployments, addresses, databases and plans, and how they fit together.

Everything in HCode lives in an organisation. An organisation holds projects, each project is one app, and each app can have databases and domains.

Organisations

An organisation is created when you order an HCode service in the HostAfrica client panel. The client panel account that placed the order becomes its owner, and the plan you ordered sets its limits. Ordering a second service gives you a second organisation.

Other people join an organisation by invite, with a role that decides what they can do: owner, admin, member or viewer. One person can belong to several organisations and switch between them in the dashboard.

See Organisations, Roles and permissions and Invite your team.

Projects

A project is one app. Its code comes from a GitHub repository and branch, or from a .zip you upload. HCode builds it in one of two ways:

  • Automatic: HCode detects your framework and builds the app for you.
  • Dockerfile: HCode builds the image from the Dockerfile in your code.

A project runs as one of two app types:

  • Web app: serves a website or API. It gets an address and receives web traffic on the port it listens on.
  • Background worker: runs a long-lived process with no web address, for queue workers, bots and similar jobs. You follow it through its logs.

Project names are unique within an organisation. See Create a project and Web apps and workers.

Deployments and releases

A deployment fetches your code, builds it and starts the new version. The dashboard shows its progress in three steps: Queued, Building and Verifying. Each deployment keeps its build log, so a failed deploy can be read afterwards.

A deployment that succeeds becomes a release. HCode keeps your most recent releases, how many depending on your plan, and rollback can return to any of those. See Deployments.

Addresses and domains

Every web app gets a generated address ending in .hcode.site, which works as soon as the first deployment succeeds. You can add your own domains to the same project, and HCode serves them over HTTPS. Background workers have no address.

See Your generated address and Custom domains.

Databases

Databases are created inside a project and belong to it. HCode offers PostgreSQL and Redis. PostgreSQL databases can also be opened to connections from outside HCode; Redis can't yet.

See Databases overview and Scheduled backups.

Plans and usage

Your organisation's plan sets its limits: projects, memory, storage, bandwidth, build minutes and team members. Owners and admins see the plan and current usage under Subscription (/settings/billing). Plan changes, payment and cancellation happen in the HostAfrica client panel.

See Plans and billing and Usage and limits.