> ## Documentation Index
> Fetch the complete documentation index at: https://docs.crane-it.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Custom projects

> Here how you can create and deploy a custom project.

CraneIt allows you to **self-host** any containerized application in minutes. It's a simple, fast, and secure way to deploy to AWS.

CraneIt also offers a *Library*, a set of projects ready for deployment in just two clicks.

***

## Get started

### Step 1: Create a project

For this step, we'll assume you've covered the quickstart tutorial.

If not, you can find it here:

<CardGroup cols={2}>
  <Card title="Quickstart" icon="chevrons-right" href="https://docs.crane-it.com/quickstart">
    Deploy your first app with Crane It
  </Card>
</CardGroup>

To create a project, simply click the *"New project"* button in the [projects tab](https://crane-it.com/logged-in/projects).

<img src="https://mintcdn.com/craneit/gTc9ME6MME9D_eex/images/createProject.png?fit=max&auto=format&n=gTc9ME6MME9D_eex&q=85&s=245996d9d0254f12091b106e1f85b95f" alt="Create Project" width="1418" height="350" data-path="images/createProject.png" />

Once done, either click one the project name (New project), or on the *"Edit"* button.

### Step 2: Customize project configuration

This section is dedicated to the global customization of your project.

As shown on the image bellow, you'll be met with the following options:

* **Https**: Whether or not to access your project via https (defaults to false / http).
* **Instance size**: Defines the ec2 instance type to use to deploy your project. Larger instances are more powerful, but cost more.
* **The configuration**: You can find additional info regarding this section in these two articles:

<CardGroup cols={2}>
  <Card title="Docker Compose" icon="docker" href="https://docs.crane-it.com/tutorials/docker_compose">
    Customize your project with docker compose.
  </Card>

  <Card title="Builder" icon="screwdriver-wrench" href="https://docs.crane-it.com/tutorials/builder">
    Customize your project with our wizard.
  </Card>
</CardGroup>

<img src="https://mintcdn.com/craneit/gTc9ME6MME9D_eex/images/customizeProjectConfig.png?fit=max&auto=format&n=gTc9ME6MME9D_eex&q=85&s=08e27ec510e2ab8d3ff49eff3adcba4d" alt="Customize project configuration" width="1244" height="1550" data-path="images/customizeProjectConfig.png" />

Don't forget to save before leaving this section!

### Step 3: Edit project details

This section is dedicated to your project's displayed info.

As shown on the image bellow, you'll be met with the following options:

* **Name**: to remember what the project does.
* **Description**: to give a little context so you don't forget anything next time.
  <img src="https://mintcdn.com/craneit/gTc9ME6MME9D_eex/images/customizeProjectDetails.png?fit=max&auto=format&n=gTc9ME6MME9D_eex&q=85&s=70772331705c16a198bd80800564209d" alt="Edit project details" width="1292" height="670" data-path="images/customizeProjectDetails.png" />

### Step 4: Edit project secrets

This section is dedicated to your project's secrets.

As shown on the image bellow, you'll be met with the following options:

* **AWS API Token**: The token that we use to manage your AWS account (<u>**DON'T SHARE THIS WITH ANYONE!**</u>).
* **AWS API Secret**: The private key that corresponds to the token (<u>**DON'T SHARE THIS WITH ANYONE!**</u>).
* **AWS Region**: When we will deploy your servers.
* **Docker Token (optional)**: The token that we use to pull images from private docker registries.
* **Docker Provider (optional)**: Where your private registry is hosted (for example github's registry is hosted at ghcr.io).
* **Env Files**: Write entire environment files, that will be uploaded to your server, and found in the .envs folder in your ec2 instance (available during boot).
* **Secrets**: Key value pairs that will be passed as environment variables during the boot sequence of your server.

<img src="https://mintcdn.com/craneit/gTc9ME6MME9D_eex/images/customizeProjectSecrets.png?fit=max&auto=format&n=gTc9ME6MME9D_eex&q=85&s=e51ef39d71cfddf2d18a3f1aa346ef8d" alt="Edit project secrets" width="1312" height="1758" data-path="images/customizeProjectSecrets.png" />
