# Getting started

## Host operations

These operations are performed on the server. They allow you to configure the projects and repositories that will be used by the team.

### Create a new project

```
tevun create <project> <template>
```

This command will add a new project in projects directory. Where `<project>` is the name of project and `<template>` can be **php** or **html**. We can add other templates too. The main idea is to have skeletons to most common structures used.

```
tevun create site.com html
```

In this example Tevun will create `site.com` project, initialize a git remote repository, configure `post-receive`, generate a `docker-compose.yml` and show the git remote URL in terminal.

![](https://2469683102-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LcGdxC_-iro75-ypwyF%2F-LcWG6jmu4FU4Zs13XsS%2F-LcWIUC-i7yQTF7wd-xw%2Fimage.png?alt=media\&token=21c0c5d7-6d09-431b-87d4-f4e6eb48dbd1)

### **Destroy a project**

```
tevun destroy <project>
```

The command destroy will stop your docker-compose project and erase the project directory.

{% hint style="danger" %}
The command will not erase the docker volumes, but is important to be careful with this instruction.
{% endhint %}

### Register users

Once the projects have been created we can make a local clone of them, but for that we need an user with access permission. To register users in Tevun use the command below:

```
tevun register <user>
```

This is a short hand to http basic auth and the file with permissions is in file `/etc/nginx/.users` of *tevun* container.

![](https://2469683102-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LcGdxC_-iro75-ypwyF%2F-LcWG6jmu4FU4Zs13XsS%2F-LcWIsewlmhtThVEUDR4%2Fimage.png?alt=media\&token=dbf2eb69-ff09-47c0-9a7d-b6a7d6b7b57b)

## Using in a workstation

After having a project created on the server we can use git to publish it and even use the sample project as the basis for working on it.

### Configure in a new project

Clone the host created in your Tevun server:

```
git clone https://<user>@<host>:<port>/<project>/repo <dir>
```

Fetch the setup branch, get setup branch from remote and merge setup branch to your local branch:

```
git fetch deploy +refs/heads/setup:refs/remotes/deploy/setup && \
git branch --track setup refs/remotes/deploy/setup && \
git merge --no-ff deploy/setup --allow-unrelated-histories
```

### **Configure in an existing project**

If you already has a project can make something like the previous section. We can get the branch setup of project repository to get the files to configure our project to run in Tevun.

Add the remote to your local repository:

```
git remote add deploy https://<user>@<host>:<port>/<project>/repo
```

Fetch the setup branch, get setup branch from remote and merge setup branch to your local branch:

```
git fetch deploy +refs/heads/setup:refs/remotes/deploy/setup && \
git branch --track setup refs/remotes/deploy/setup && \
git merge --no-ff deploy/setup --allow-unrelated-histories
```

### Git issues

If a ***host*** with https support is not being used, we can use a configuration for `git` to be more flexible with respect to the certificate

```
git config http.sslVerify false
```

### Using a full qualified name with git

The Tevun configuration will not configure a dedicated virtual host for the tevun container, but it is quite easy to do so. Go to the Tevun installation folder and open the file `docker-compose.yml`. Set the tevun container to leave the `environment` property as the image below

![](https://2469683102-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LcGdxC_-iro75-ypwyF%2F-LfXVzJngxwH5gM2yLxQ%2F-LfXantMrMv3aU6C3SNp%2Fimage.png?alt=media\&token=b94426cf-1ae2-4e4e-9732-7275854d6ead)

{% code title="docker-compose.yml" %}

```yaml
version: '3.7'
#  ...
services:
#  ...
 tevun:
#  ...
  environment:
    - VIRTUAL_HOST=tevun.mydomain.com
    - LETSENCRYPT_EMAIL=it@mydomain.com
    - LETSENCRYPT_HOST=tevun.mydomain.com
```

{% endcode %}

After update `docker-compose.yml` restart the project

```
docker-compose down && docker-compose up -d
```