Skip to content

Commit

Permalink
Update links in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
wiliansilvazup committed Aug 24, 2021
1 parent 37d8327 commit c4fcc11
Show file tree
Hide file tree
Showing 14 changed files with 35 additions and 35 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/security-pipeline.yml
Expand Up @@ -25,5 +25,5 @@ jobs:
HORUSEC_CLI_HORUSEC_API_URI: ${{ secrets.HORUSEC_CLI_HORUSEC_API_URI }}
HORUSEC_CLI_REPOSITORY_NAME: ${{ secrets.HORUSEC_CLI_REPOSITORY_NAME }}
run: |
curl -fsSL https://raw.githubusercontent.com/ZupIT/horusec/master/deployments/scripts/install.sh | bash -s latest
curl -fsSL https://raw.githubusercontent.com/ZupIT/horusec/main/deployments/scripts/install.sh | bash -s latest
horusec start -p . -e true -G true
2 changes: 1 addition & 1 deletion content/en/cli/analysis-tools/security-tools.md
Expand Up @@ -34,7 +34,7 @@ If you want to know more about Gosec criteria, access the [**rules list**](https

[**GitLeaks**](https://github.com/zricethezav/gitleaks) is a [**SAST**](../../../../../../key-concepts#sast-static-application-security-testing) tool to dectect encrypted code like passwords, API keys and tokens in all git repository history.

If you want to know more about GitLeaks criteria, access the [**rules list**](https://github.com/ZupIT/horusec/blob/master/deployments/dockerfiles/gitleaks/rules.toml) that the tool applies in its analysis.
If you want to know more about GitLeaks criteria, access the [**rules list**](https://github.com/ZupIT/horusec/blob/main/deployments/dockerfiles/gitleaks/rules.toml) that the tool applies in its analysis.

### NpmAudit

Expand Down
14 changes: 7 additions & 7 deletions content/en/cli/installation.md
Expand Up @@ -35,7 +35,7 @@ Check out next, the command you need to install Horusec locally according to you
To install Horusec-CLI on MacOS or Linux, you have to run the command below in your terminal:

```bash
curl -fsSL https://raw.githubusercontent.com/ZupIT/horusec/master/deployments/scripts/install.sh | bash -s latest
curl -fsSL https://raw.githubusercontent.com/ZupIT/horusec/main/deployments/scripts/install.sh | bash -s latest
```

### **Windows**
Expand Down Expand Up @@ -64,7 +64,7 @@ If you need to download for a specific version / operating system. In this case,

👉[**Lastest available version**](https://github.com/ZupIT/horusec/releases/latest)

👉[**All available versions**](https://raw.githubusercontent.com/ZupIT/horusec/master/deployments/all-version-cli.txt)
👉[**All available versions**](https://raw.githubusercontent.com/ZupIT/horusec/main/deployments/all-version-cli.txt)

{{% /alert %}}

Expand All @@ -91,7 +91,7 @@ The links below are to download the lastest version:

👉[**Lastest available version**](https://github.com/ZupIT/horusec/releases/latest)

👉[**All available versions**](https://raw.githubusercontent.com/ZupIT/horusec/master/deployments/all-version-cli.txt)
👉[**All available versions**](https://raw.githubusercontent.com/ZupIT/horusec/main/deployments/all-version-cli.txt)


## **Installation via image docker**
Expand Down Expand Up @@ -134,7 +134,7 @@ jobs:
uses: actions/checkout@v2
- name: Running Horusec Security
run: |
curl -fsSL https://raw.githubusercontent.com/ZupIT/horusec/master/deployments/scripts/install.sh | bash -s latest
curl -fsSL https://raw.githubusercontent.com/ZupIT/horusec/main/deployments/scripts/install.sh | bash -s latest
horusec start -p="./" -e="true"
```

Expand Down Expand Up @@ -182,7 +182,7 @@ jobs:
- run:
name: Horusec Security Test
command: |
curl -fsSL https://raw.githubusercontent.com/ZupIT/horusec/master/deployments/scripts/install.sh | bash -s latest
curl -fsSL https://raw.githubusercontent.com/ZupIT/horusec/main/deployments/scripts/install.sh | bash -s latest
horusec start -p="./" -e="true"
workflows:
pipeline:
Expand All @@ -199,7 +199,7 @@ stages {
docker { image 'docker:dind' }
}
steps {
sh 'curl -fsSL https://raw.githubusercontent.com/ZupIT/horusec/master/deployments/scripts/install.sh | bash -s latest'
sh 'curl -fsSL https://raw.githubusercontent.com/ZupIT/horusec/main/deployments/scripts/install.sh | bash -s latest'
sh 'horusec start -p="./" -e="true"'
}
}
Expand All @@ -213,7 +213,7 @@ pool:
vmImage: 'ubuntu-18.04'

steps:
- script: curl -fsSL https://raw.githubusercontent.com/ZupIT/horusec/master/deployments/scripts/install.sh | bash -s latest && horusec start -p ./
- script: curl -fsSL https://raw.githubusercontent.com/ZupIT/horusec/main/deployments/scripts/install.sh | bash -s latest && horusec start -p ./
```

### GitLab CI/CD
Expand Down
10 changes: 5 additions & 5 deletions content/en/tutorials/how-to-change-authentication-types.md
Expand Up @@ -24,9 +24,9 @@ The value can be anyone of your choice, but it is necessary to have a strong has

To configure this authentication, follow the steps:

1. Add the environment variable **`HORUSEC_AUTH_TYPE=”ldap”`** in the [**horusec-auth**](https://github.com/ZupIT/horusec/tree/master/horusec-auth) microservice to define the authentication via LDAP;
1. Add the environment variable **`HORUSEC_AUTH_TYPE=”ldap”`** in the [**horusec-auth**](https://github.com/ZupIT/horusec-platform/tree/main/auth) microservice to define the authentication via LDAP;

2. Add some environment variables in the microservice [**horusec-auth**](https://github.com/ZupIT/horusec/tree/master/horusec-auth) to make the connection with the tool, they are:
2. Add some environment variables in the microservice [**horusec-auth**](https://github.com/ZupIT/horusec-platform/tree/main/auth) to make the connection with the tool, they are:

<table>
<thead>
Expand Down Expand Up @@ -105,9 +105,9 @@ To configure this authentication, follow the steps:

To configure this authentication, follow the steps:

1. Add the environment variable **`HORUSEC_AUTH_TYPE=”keycloak”`** in the [**horusec-auth**](https://github.com/ZupIT/horusec/tree/master/horusec-auth) microservice that you will use in the authentication via Keycloak;
1. Add the environment variable **`HORUSEC_AUTH_TYPE=”keycloak”`** in the [**horusec-auth**](https://github.com/ZupIT/horusec-platform/tree/main/auth) microservice that you will use in the authentication via Keycloak;

2. In the [**horusec-auth**](https://github.com/ZupIT/horusec/tree/master/horusec-auth) microservice, add the connection variables with the keycloak, which are:
2. In the [**horusec-auth**](https://github.com/ZupIT/horusec-platform/tree/main/auth) microservice, add the connection variables with the keycloak, which are:

| **Environment variable name** | **Standard value** | **Description** |
| :--- | :--- | :--- |
Expand All @@ -117,7 +117,7 @@ To configure this authentication, follow the steps:
| HORUSEC\_KEYCLOAK\_REALM | | What is the realm used. Example: master. |
| HORUSEC\_KEYCLOAK\_OTP | false | If you are using otp \(one-time password\). |

Then, to connect correctly, the [**horusec-manager**](https://github.com/ZupIT/horusec/tree/master/horusec-manager) will also need some environment variables:
Then, to connect correctly, the [**horusec-manager**](https://github.com/ZupIT/horusec-platform/tree/main/manager) will also need some environment variables:

| **Environment variable name** | **Standard value** | **Description** |
| :--- | :--- | :--- |
Expand Down
Expand Up @@ -49,7 +49,7 @@ When the microservices have the `HORUSEC_DISABLED_EMAILS` environment variable w

By default, the microservices below already start with a **false** value:

- [**horusec-Auth**](https://github.com/ZupIT/horusec/tree/master/horusec-auth)
- [**horusec-Auth**](https://github.com/ZupIT/horusec-platform/tree/main/auth)

If the `HORUSEC_DISABLED_EMAILS` microservice value is **true**, the messaging service will be disabled.
To enable it, it's only necessary to change the value to **false**.
Expand Down
Expand Up @@ -31,7 +31,7 @@ To do so:

**Example using docker-compose**

When you use the `make install` command, it runs the [**docker-compose.yaml**](https://github.com/ZupIT/horusec/blob/master/deployments/docker-compose.yaml) Horusec's default.
When you use the `make install` command, it runs the [**docker-compose.yaml**](https://github.com/ZupIT/horusec/blob/main/deployments/docker-compose.yaml) Horusec's default.
The Horusec-Manager is being executed with the following configuration:

```yaml
Expand Down
2 changes: 1 addition & 1 deletion content/en/tutorials/how-to-setup-tool.md
Expand Up @@ -85,7 +85,7 @@ With this configuration:

* It is possible to disable/enable a tool when you start an analysis changing the **`istoignore`** key;

* It is possible to use a image of your own registry. See the [**list of all languages and your deployments**](https://github.com/ZupIT/horusec/tree/master/horusec-cli/internal/services/formatters) that you can use and upload on your private registry. To change it, put the link that would be used to download the registry's image on the respective **`language`**.
* It is possible to use a image of your own registry. See the [**list of all languages and your deployments**](https://github.com/ZupIT/horusec/tree/main/internal/services/formatters) that you can use and upload on your private registry. To change it, put the link that would be used to download the registry's image on the respective **`language`**.

* The languages that use only the **own Horusec's engine** to run natively, so it doesn't need to be changed on your registry, because they already inside of Horusec-CLI.

Expand Down
4 changes: 2 additions & 2 deletions content/en/web/installation/install-with-docker-compose.md
Expand Up @@ -28,7 +28,7 @@ There is a **configuration file** on Horusec with all the default option for you
This file can only be used for a testing scenario, never the production one.
{{% /alert %}}

- You can get the [**configuration file**](https://github.com/ZupIT/horusec-platform/blob/master/deployments/compose/compose.yaml) on Horusec's repository.
- You can 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:
1. Clone the repository;
Expand Down Expand Up @@ -90,7 +90,7 @@ Horusec's images are available on [**dockerhub**](https://hub.docker.com/u/horus
## **Reminders**

{{% alert color="warning" %}}
1. All these configurations available on Horusec's [**docker-compose.yaml**](https://github.com/ZupIT/horusec-platform/blob/master/deployments/compose/compose.yaml) are default. It's recommended to change some information (like the user and database password) when using this service in a production environment.
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. It's recommended to change some information (like the user and database password) when using this service in a production environment.



Expand Down
2 changes: 1 addition & 1 deletion content/pt-br/cli/analysis-tools/security-tools.md
Expand Up @@ -38,7 +38,7 @@ O [**Gosec**](https://github.com/securego/gosec) é uma ferramenta que inspecion

### **GitLeaks**

O [**GitLeaks**](https://github.com/zricethezav/gitleaks) é uma ferramenta [**SAST**](../../../../key-concepts/#sast-static-application-security-testing) para detectar segredos codificados como senhas, chaves de API e tokens em todo o histórico dos repositórios git. Para entender melhor os critérios do GitLeaks, acesse a [**lista de regras** ](https://github.com/ZupIT/horusec/blob/master/deployments/dockerfiles/gitleaks/rules.toml)que a ferramenta aplica em suas análises.
O [**GitLeaks**](https://github.com/zricethezav/gitleaks) é uma ferramenta [**SAST**](../../../../key-concepts/#sast-static-application-security-testing) para detectar segredos codificados como senhas, chaves de API e tokens em todo o histórico dos repositórios git. Para entender melhor os critérios do GitLeaks, acesse a [**lista de regras** ](https://github.com/ZupIT/horusec/blob/main/deployments/dockerfiles/gitleaks/rules.toml)que a ferramenta aplica em suas análises.

### **NpmAudit**

Expand Down
14 changes: 7 additions & 7 deletions content/pt-br/cli/installation.md
Expand Up @@ -34,7 +34,7 @@ Confira, a seguir, o comando necessário para instalar o Horusec localmente de a
Para instalar o Horusec nos sistemas MacOS ou Linux, basta rodar o comando abaixo no seu terminal:

```bash
curl -fsSL https://raw.githubusercontent.com/ZupIT/horusec/master/deployments/scripts/install.sh | bash -s latest
curl -fsSL https://raw.githubusercontent.com/ZupIT/horusec/main/deployments/scripts/install.sh | bash -s latest
```

### Windows
Expand Down Expand Up @@ -62,7 +62,7 @@ Caso você precise fazer o download para uma versão e/ou sistema operacional es

👉[**A última versão disponível**](https://github.com/ZupIT/horusec/releases/latest)

👉[**Todas as versões disponíveis** ](https://raw.githubusercontent.com/ZupIT/horusec/master/deployments/all-version-cli.txt)
👉[**Todas as versões disponíveis** ](https://raw.githubusercontent.com/ZupIT/horusec/main/deployments/all-version-cli.txt)

{{% /alert %}}

Expand Down Expand Up @@ -90,7 +90,7 @@ Caso queira uma versão específica, basta trocar a palavra `latest` no link pel

👉[**A última versão disponível**](https://github.com/ZupIT/horusec/releases/latest)

👉[**Todas as versões disponíveis** ](https://raw.githubusercontent.com/ZupIT/horusec/master/deployments/all-version-cli.txt)
👉[**Todas as versões disponíveis** ](https://raw.githubusercontent.com/ZupIT/horusec/main/deployments/all-version-cli.txt)


## **Instalação via Imagem Docker**
Expand Down Expand Up @@ -134,7 +134,7 @@ jobs:
uses: actions/checkout@v2
- name: Running Horusec Security
run: |
curl -fsSL https://raw.githubusercontent.com/ZupIT/horusec/master/deployments/scripts/install.sh | bash -s latest
curl -fsSL https://raw.githubusercontent.com/ZupIT/horusec/main/deployments/scripts/install.sh | bash -s latest
horusec start -p="./" -e="true"
```

Expand Down Expand Up @@ -182,7 +182,7 @@ jobs:
- run:
name: Horusec Security Test
command: |
curl -fsSL https://raw.githubusercontent.com/ZupIT/horusec/master/deployments/scripts/install.sh | bash -s latest
curl -fsSL https://raw.githubusercontent.com/ZupIT/horusec/main/deployments/scripts/install.sh | bash -s latest
horusec start -p="./" -e="true"
workflows:
pipeline:
Expand All @@ -199,7 +199,7 @@ stages {
docker { image 'docker:dind' }
}
steps {
sh 'curl -fsSL https://raw.githubusercontent.com/ZupIT/horusec/master/deployments/scripts/install.sh | bash -s latest'
sh 'curl -fsSL https://raw.githubusercontent.com/ZupIT/horusec/main/deployments/scripts/install.sh | bash -s latest'
sh 'horusec start -p="./" -e="true"'
}
}
Expand All @@ -213,7 +213,7 @@ pool:
vmImage: 'ubuntu-18.04'

steps:
- script: curl -fsSL https://raw.githubusercontent.com/ZupIT/horusec/master/deployments/scripts/install.sh | bash -s latest && horusec start -p ./
- script: curl -fsSL https://raw.githubusercontent.com/ZupIT/horusec/main/deployments/scripts/install.sh | bash -s latest && horusec start -p ./
```

### GitLab CI/CD
Expand Down
Expand Up @@ -25,9 +25,9 @@ O valor pode ser qualquer um da sua escolha, mas é necessário ser um hash fort

Para configurar essa autenticação, siga os passos:

1. Adicione a variável de ambiente `HORUSEC_AUTH_TYPE=”ldap”` no microsserviço [**horusec-auth**](https://github.com/ZupIT/horusec/tree/master/horusec-auth) para definir a autenticação via LDAP.
1. Adicione a variável de ambiente `HORUSEC_AUTH_TYPE=”ldap”` no microsserviço [**horusec-auth**](https://github.com/ZupIT/horusec-platform/tree/main/auth) para definir a autenticação via LDAP.

2. Adicione algumas variáveis de ambiente no microsserviço [**horusec-auth**](https://github.com/ZupIT/horusec/tree/master/horusec-auth) para realizar a conexão com a ferramenta.
2. Adicione algumas variáveis de ambiente no microsserviço [**horusec-auth**](https://github.com/ZupIT/horusec-platform/tree/main/auth) para realizar a conexão com a ferramenta.

Veja as váriaveis disponíveis abaixo:

Expand Down Expand Up @@ -109,7 +109,7 @@ Veja as váriaveis disponíveis abaixo:

Para configurar essa autenticação, siga os passos:

1. Adicione a variável de ambiente `HORUSEC_AUTH_TYPE=”keycloak”` no microsserviço [**horusec-auth**](https://github.com/ZupIT/horusec/tree/master/horusec-auth) que você irá utilizar na autenticação via Keycloak.
1. Adicione a variável de ambiente `HORUSEC_AUTH_TYPE=”keycloak”` no microsserviço [**horusec-auth**](https://github.com/ZupIT/horusec-platform/tree/main/auth) que você irá utilizar na autenticação via Keycloak.

2. Adicione as variáveis de conexão com o Keycloak.

Expand All @@ -123,7 +123,7 @@ Veja as váriaveis disponíveis abaixo:
| HORUSEC\_KEYCLOAK\_REALM | | Qual é o realm utilizado. Exemplo: master. |
| HORUSEC\_KEYCLOAK\_OTP | false | Se está utilizando otp\(one-time password\). |

3. Conecte o [**horusec-manager**](https://github.com/ZupIT/horusec/tree/master/horusec-manager) com algumas variáveis de ambiente, veja abaixo:
3. Conecte o [**horusec-manager**](https://github.com/ZupIT/horusec-platform/tree/main/manager) com algumas variáveis de ambiente, veja abaixo:

| **Nome da variável de ambiente** | **Valor padrão** | **Descrição** |
| :--- | :--- | :--- |
Expand Down
Expand Up @@ -37,7 +37,7 @@ Para fazer isso:

**Exemplo utilizando docker-compose**

Quando você utiliza o comando `make install` ele executa o [**compose.yaml**](https://github.com/ZupIT/horusec-platform/blob/master/deployments/compose/compose.yaml) padrão do Horusec.
Quando você utiliza o comando `make install` ele executa o [**compose.yaml**](https://github.com/ZupIT/horusec-platform/blob/main/deployments/compose/compose.yaml) padrão do Horusec.
O Horusec-Manager está sendo executado com a seguinte configuração:

```yaml
Expand Down
2 changes: 1 addition & 1 deletion content/pt-br/tutorials/how-to-setup-tool.md
Expand Up @@ -87,7 +87,7 @@ Com essa configuração:

* É possível desabilitar/habilitar uma ferramenta quando você inicia uma análise alterando a chave **`istoignore`**;

* É possível utilizar a imagem do seu próprio registro. Veja a [**lista de todos as linguagens e seus deployments**](https://github.com/ZupIT/horusec/tree/master/horusec-cli/internal/services/formatters) que você pode utilizar e subir no seu registro privado.
* É possível utilizar a imagem do seu próprio registro. Veja a [**lista de todos as linguagens e seus deployments**](https://github.com/ZupIT/horusec/tree/main/internal/services/formatters) que você pode utilizar e subir no seu registro privado.
Para alterar, coloque o link que seria utilizado para realizar download da imagem deste registro da sua respectiva **`linguagem`**.

* As linguagem que utilizam somente o **próprio motor do Horusec** rodam de forma nativa, então não precisam ser alteradas em seu registro, porque já estão dentro da Horusec-CLI.
Expand Down
4 changes: 2 additions & 2 deletions content/pt-br/web/installation/install-with-docker-compose.md
Expand Up @@ -34,7 +34,7 @@ Esse arquivo deve ser usado para cenário de testes, nunca de produção.
{{% /alert %}}


Você pode obter o [**arquivo de configuração**](https://github.com/ZupIT/horusec-platform/blob/master/deployments/compose/compose.yaml) no repositório do Horusec:
Você pode obter o [**arquivo de configuração**](https://github.com/ZupIT/horusec-platform/blob/main/deployments/compose/compose.yaml) no repositório do Horusec:

1. Clone o repositório do Horusec em seu ambiente;
2. Acesse a pasta onde clonou o repositório
Expand Down Expand Up @@ -91,7 +91,7 @@ Hoje o Horusec disponibiliza todas as suas imagens no [**dockerhub**](https://hu
## **Avisos importantes**

{{% alert color="warning" %}}
1. Todas as configurações que o Horusec disponibiliza em seu [**docker-compose.yaml**](https://github.com/ZupIT/horusec-platform/blob/master/deployments/compose/compose.yaml) são padrões, assim como seus dados. Por isso, é recomendado que você altere algumas informações (como usuário e senha de banco de dados) ao utilizar esse serviço em um ambiente de produção.
1. Todas as configurações que o Horusec disponibiliza em seu [**docker-compose.yaml**](https://github.com/ZupIT/horusec-platform/blob/main/deployments/compose/compose.yaml) são padrões, assim como seus dados. Por isso, é recomendado que você altere algumas informações (como usuário e senha de banco de dados) ao utilizar esse serviço em um ambiente de produção.


2. O Horusec está sempre em atualização e correção de imagens. Para saber qual imagem utilizar em cada versão específica, acesse nossas [**release-notes**](https://github.com/ZupIT/horusec-platform/releases) as versões corretas de cada serviço
Expand Down

0 comments on commit c4fcc11

Please sign in to comment.