|
|
|
# VM4SEC Projects API
|
|
|
|
|
|
|
|
Welcome to the VM4SEC Dashboard Project API repository. This project contains the C# and Docker files for the VM4SEC Dashboard project's backend.
|
|
|
|
|
|
|
|
The VM4SEC Dashboard Project backend relies on [PostgreSQL](https://www.postgresql.org/) and C# for providing a RESTfull API for creating, editing and deleting projects.
|
|
|
|
|
|
|
|
# Installation of VM4SEC Projects API using Docker
|
|
|
|
|
|
|
|
In this section, we provide instructions on how the user can build a new Docker Image that contains the VM4SEC Dashboard Project backend. We highly recommend the users to select this way of installing the backend server, as it constitutes the easiest way.
|
|
|
|
|
|
|
|
- **Step 1**: Download and install [Docker](https://www.docker.com/) and [Docker Compose](https://docs.docker.com/compose/install/)
|
|
|
|
- **Step 2**: Clone the latest VM4SEC Dashboard Project API version and navigate to the home directory. You should see a `docker-compose.yml` file, which contains the Docker compose steps. If needed, you can configure various parameters according to your needs, such as the names of the containers or the port (remember to update also the the `.env` configuration file within the VM4SEC Dashboard).
|
|
|
|
- **Step 3**: In the home directory of the VM4SEC Dashboard Project API, open cmd and execute the following command:
|
|
|
|
```bash
|
|
|
|
sudo docker-compose up --build -d
|
|
|
|
```
|
|
|
|
This command will result in the creation and deployment of two Docker containers named *vm4secprojectapi* and *vm4secprojectdb*.
|
|
|
|
- **Step 4**: To ensure that the backend server is up and running, navigate to <http://localhost:3005/swagger/index.html> (or to the correct port in case you updated the `docker-compose.yml` file). |
|
|
|
\ No newline at end of file |
