---
# System prepended metadata

title: Untitled

---

## Setup the project
Download and Install Git from [here](https://git-scm.com/download/).
Go with default settings.

Windows User need to enable long path support on the system.

### Enable long path (Windows Only)
Navigate to the "security-passport" folder
Open the Git Bash and run as administrator
To enable the long paths, run following in git bash:
```

git config core.longpaths true
```

To enable Win32 Long Paths through gpedit or Local Group Policy Editor (optional):

1. Search for gpedit and open it from the Start Menu or Run box
1. Click on the Filesystem folder on the sidebar
1. In the files of Filesystem, double-click on Enable Win32 long paths
1. Check the radio button beside Enabled
1. Click on OK to save the changes


### Clone the Repository
```
git clone https://github.tools.sap/security-passport/security-passport.git
```

During the cloning Git will ask for access token. You can generate it on [GitHub](https://github.tools.sap/settings/tokens)

### Setup Docker

For installing Docker follow the guide.

* [Windows](https://docs.docker.com/desktop/windows/install/)
* [Linux](https://docs.docker.com/engine/install/)
* [Mac](https://docs.docker.com/desktop/mac/install/)

Run the following command in PowerShell for creating the Database instance. Replace the <password> with correct password.  

```
docker run -p 5432:5432 --name security-passport-postgres --restart allways -e POSTGRES_PASSWORD="<password>" -v postgres_data:/var/lib/postgresql/data -d postgres:12-alpine
```
    
### Setup Database
    
Connect to the database. 
[How to connect to a Database](#How-to-connect-to-a-Database)
    
Create a user for the passport and give the user the right permission to db.
This credentials need to be inserted in the .env file. 
    

## How to connect to a Database

The passport team using DBeaver as management tool for the db purpose.
We highly recommend to use it.

[DBeaver](https://dbeaver.io/download/)
    

* Open the New Connection Wizard
* Select PostgreSQL
* Add connection information
    
For the local connection data look on the .env file in the passport-api. 
    
For remote connection data you need to search it in the Environment Variables on the API-Service of the needed Landscape. 
    
Host: localhost
Port: local 5432 and remote 5435
    