Projects & environments

Four objects cover everything Hiraiship does. Each contains the next.

workspace
└── project            my-app
    ├── environment    production   → my-app.hiraiship.app
    │   ├── deployment (live)
    │   ├── deployment
    │   └── domain     www.example.com
    └── environment    staging      → staging.example.com

Workspaces

A workspace is where projects live, and what a plan applies to: its limits, usage and spend limit cover every project in it. You get a personal workspace when you sign up, and you can be a member of others.

Members have a role (owner, admin, developer or viewer) that decides what they can do. Only owners, admins and developers can deploy.

Projects

A project is one app: one repository, or one directory you deploy from. It has:

• a name, shown in the dashboard;
• a slug, made of lowercase letters, digits and hyphens. It names the project in URLs and becomes its default address, <slug>.hiraiship.app, so it must be free across Hiraiship;
• build settings: install command, build command, output directory and build machine. See Build settings.

A workspace can have as many projects as you want. New ones are rate-limited per hour; see Limits.

Environments

An environment is one running copy of a project, with its own variables, domains and deployments. Every project starts with production, which gets the <slug>.hiraiship.app address.

You can add more, staging for instance, up to your plan's environments per project. An environment you add has no address of its own: point a custom domain at it to reach it.

Deployments

A deployment is one build of your code, in one environment. When a build succeeds, it becomes that environment's current deployment and starts serving traffic. Earlier successful deployments are kept, so you can roll back to one of them in seconds.

See Deployment lifecycle.

Domains

A domain sends traffic for a hostname to an environment, or redirects it to another domain of the project. production always has its hiraiship.app domain; you add your own on top.