Skip to main content

​
Overview

You can create a Project from scratch, from a Project template, or from existing work by copying or forking another Project. Starting from existing work is often fastest: search your Domino deployment for Projects you can build on, and check the tabs on your Project’s home page for Projects where you are a collaborator and Projects that Domino recommends.

​
How it works

  • You choose the Project type when you create the Project: select a Git provider for a Git-based Project, or Domino (local hosting) for a Domino File System (DFS) Project.
  • Git-based Projects with private repositories need Git credentials stored in your Domino account so Domino can authenticate with your Git provider; public repositories don’t. Domino supports HTTPS and SSH connections for both.
  • Project templates are supported for Git-based Projects only.

​
Add Git credentials

If you are connecting a private repository, want to write commits back to the remote, or use SSH, add Git credentials to your Domino account first. Domino stores SSH private keys, personal access tokens (PATs), and usernames with passwords.
Use an SSH private key when the repository URI has the form:
<user>@<domain>:<username>/<repository>.git
Set up SSH access with your Git service first: GitHub, GitLab, or Bitbucket.
  1. Copy your entire private key, including the -----BEGIN OPENSSH PRIVATE KEY----- and -----END OPENSSH PRIVATE KEY----- header and footer. If you used the standard name and location, the key is in ~/.ssh/id_rsa.
  2. In Domino, go to Account > Account Settings > Git Credentials and click + Add Git Credentials.
  3. Choose the Git service provider, name the credential, and select Private SSH Key as the access type.
  4. Paste the private key. If the key requires a passphrase, enter it.
  5. Click Add Credentials.
If your GitHub organization requires single sign-on (SSO), you must authorize the SSH key for SSO before Domino can access private repositories.

​
Create a Project

Create a new Project
  1. Start the Project wizard:
    In the navigation pane, click Develop > Projects, then click Create Project.
  2. Name and configure the Project:
    Enter a Project name, select a Project template or None (start from scratch), set the Project’s Visibility, and click Next.
  3. Choose where the code lives:
    Select your Git provider for a Git-based Project, or Domino (local hosting) for a DFS Project.
  4. Connect the repository (Git-based only):
    Select your credentials; click + Add credentials if none are listed. Then point Domino at the repository: with SSH credentials, enter the Git repository URL; with PAT credentials, you can also have Domino create the repository or pick one from your provider.
  5. Create the Project:
    Click Create. The Project is ready for you to add files and start work.
If the repository contains files larger than 2 GB, Domino still creates the Git-based Project, but workspace setup can fail. In that case, consider a DFS Project. Use git-sizer to check the total repository size and the size of individual files.
Project owners can set a default Git branch in Project settings. The selected branch auto-fills across the Project and can be changed anytime.

​
Create a Project from a template

Project templates let you start from a working prototype instead of from scratch, which speeds up setup and spreads your organization’s standards. Templates marked official are approved by an admin or librarian.
For templates stored in GitHub or GitHub Enterprise, the code repository must be marked as a template repository before Projects can be created from it.
  1. On the Projects page, open the Templates tab. Filter by Official templates to see approved ones.
  2. Click the template you want to start from.
  3. Choose where to store the code:
    • New repository: Domino creates a repository and copies the template code into it.
    • Existing repository (empty): Domino copies the template code into the repository. A README.md is overwritten; any other existing file makes the operation fail.
    • Existing repository (with code): Domino includes only the template’s Project assets and does not copy code files.

​
Create a template

To turn one of your Projects into a template:
  1. Open the Project and click Create Template. For GitHub and GitHub Enterprise, the button only appears if the Project’s code repository is a template repository.
  2. Enter a template name, an optional description, and the access level.
  3. Select the assets to copy into the template, and optionally set a default billing tag, default Environment, and default Hardware Tier. Activities, reviews, Workspaces, Jobs, Experiments, and comments can’t be copied into a template.
  4. Choose where to store the template’s code files: the provider, credentials (only PAT credentials are supported), and the repository. An existing repository must be empty; a README.md is overwritten, and any other file makes the operation fail.
  5. Create the template.
To mark a template as official, open the Templates tab, hover over the template, click Edit Details, and check Mark this as an official template. Only an admin or librarian can set this flag; once a template is official, practitioners can no longer modify or delete it.
Known issue: System administrators can’t view template details. As a workaround, share the template with the administrator by adding them as a collaborator.