Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[chore] doc: various fixes #155

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[chore] doc: various fixes #155

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 11 additions & 9 deletions content/en/web/installation/install-with-docker-compose.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,12 @@ We don't recommend you to install Horusec using Docker-Compose in your **product


## **Requirements**

Check out the requirements in the [**Set up section**]({{< ref path="/web/set-up.md" lang="en">}}) section.


## **Configuration**

Horusec has a **configuration file** with default options for your enviroment configuration.

{{% alert color="info"%}}
Expand All @@ -29,10 +31,11 @@ This file can only be used for a testing scenario, don't use it for the producti
- Get the [**configuration file**](https://github.com/ZupIT/horusec-platform/blob/main/deployments/compose/compose.yaml) on Horusec's repository.

Follow the next steps to configure:

**Step 1.** Clone the repository:

```bash
git clone https://github.com/ZupIT/horusec-platform.git

```

**Step 2.** Enter the folder you have cloned:
Expand All @@ -51,13 +54,12 @@ make install

Access the [**http://localhost:8043**](http://localhost:8043) to view the web application screens, showed by [**Horusec-Manager**]({{< ref path="/web/services/manager/introduction.md" lang="en">}}) service.



{{% alert color="info" %}}
The configuration file has all Horusec's services that will be exposed and executed in your machine.
{{% /alert %}}

## **Teste**
## **Test**

For test cases, Horusec gives you a default e-mail and a password to access the platform, see below:

```text
Expand All @@ -72,6 +74,7 @@ All backend services are exposed using **network_mode: "host"**, check if you ha
{{% /alert %}}

## **Images**

Horusec's images are available on [**Dockerhub**](https://hub.docker.com/u/horuszup). You can check and use them, see below:

* [**horuszup/horusec-manager**](https://hub.docker.com/r/horuszup/horusec-manager)
Expand All @@ -81,7 +84,7 @@ Horusec's images are available on [**Dockerhub**](https://hub.docker.com/u/horus
* [**horuszup/horusec-analytic**](https://hub.docker.com/r/horuszup/horusec-analytic)
* [**horuszup/horusec-migration**](https://hub.docker.com/r/horuszup/horusec-migration)
* [**horuszup/horusec-vulnerability**](https://hub.docker.com/r/horuszup/horusec-vulnerability)
* [**horuszup/horusec-messages**](https://hub.docker.com/r/horuszup/horusec-messages) (It is a requirement when you are using the [**e-mail service**]({{< ref path="/tutorials/how-to-enable-disable-messaging-service" lang="en">}})
* [**horuszup/horusec-messages**](https://hub.docker.com/r/horuszup/horusec-messages) (It is a requirement when you are using the [**e-mail service**]({{< ref path="/tutorials/how-to-enable-disable-messaging-service" lang="en">}}))
* [**horuszup/horusec-webhook**](https://hub.docker.com/r/horuszup/horusec-webhook)

![](/docs/ptbr/web/installing/docker-compose/0-installing.gif)
Expand All @@ -91,11 +94,9 @@ Horusec's images are available on [**Dockerhub**](https://hub.docker.com/u/horus
{{% alert color="warning" %}}
1. All these configurations available on Horusec's [**docker-compose.yaml**](https://github.com/ZupIT/horusec-platform/blob/main/deployments/compose/compose.yaml) are default. We recommend you change some information (like the user and database password) when using this service in a production environment.


2. Horusec always updates the images and performs corrections to know which image to use in specific versions. Check out the [**Release Notes**](https://github.com/ZupIT/horusec/releases) to see the correct versions for each service.


3. There is [**a new policy access to download public Dockerhub images**](https://docs.docker.com/docker-hub/download-rate-limit/). We recommend you upload images in the register if you want to avoid problems.
3. There is [**a new policy access to download public Dockerhub images**](https://docs.docker.com/docker-hub/download-rate-limit/). We recommend you upload images in your own registry if you want to avoid problems.

4. When you enable the messaging service, it is necessary to connect to your e-mail service. For that, add to **"horusec-messages"** the following environment variables:
- HORUSEC_SMTP_USERNAME="e-mail service username";
Expand All @@ -106,4 +107,5 @@ Horusec's images are available on [**Dockerhub**](https://hub.docker.com/u/horus
{{% /alert %}}

### Read more
- [**How to use Horusec without Docker?**]({{< ref path="/tutorials/how-to-use-horusec-without-docker" lang="en">}})

- [**How to use Horusec without Docker?**]({{< ref path="/tutorials/how-to-use-horusec-without-docker" lang="en">}})