diff --git a/README.md b/README.md index dcc9bd91..a8e03747 100644 --- a/README.md +++ b/README.md @@ -3,121 +3,102 @@ [![CircleCI](https://circleci.com/gh/yggdrasil-network/yggdrasil-go.svg?style=shield&circle-token=:circle-token )](https://circleci.com/gh/yggdrasil-network/yggdrasil-go) -## Introduction +## Introdução -Yggdrasil is an early-stage implementation of a fully end-to-end encrypted IPv6 -network. It is lightweight, self-arranging, supported on multiple platforms and -allows pretty much any IPv6-capable application to communicate securely with -other Yggdrasil nodes. Yggdrasil does not require you to have IPv6 Internet -connectivity - it also works over IPv4. +O Yggdrasil é uma implementação inicial de uma rede IPv6 totalmente criptografada de ponta a ponta. É leve, auto-organizado, é suportado em várias plataformas e permite que praticamente qualquer aplicativo compatível com IPv6 se comunique de forma segura com outros nós do Yggdrasil. O Yggdrasil não exige que você tenha conectividade com a Internet IPv6 - ele também funciona com IPv4. -Although Yggdrasil shares many similarities with -[cjdns](https://github.com/cjdelisle/cjdns), it employs a different routing -algorithm based on a globally-agreed spanning tree and greedy routing in a -metric space, and aims to implement some novel local backpressure routing -techniques. In theory, Yggdrasil should scale well on networks with -internet-like topologies. +Embora Yggdrasil compartilhe muitas semelhanças com [cjdns](https://github.com/cjdelisle/cjdns), emprega um algoritmo de roteamento diferente com base em uma árvore de abrangência globalmente acordada e roteamento ganancioso em um espaço métrico, e visa implementar algumas novas técnicas de roteamento de contrapressão local. Em teoria, o Yggdrasil deve escalar bem em redes com topologias semelhantes à Internet. -## Supported Platforms +## Plataformas Suportadas -We actively support the following platforms, and packages are available for -some of the below: +Apoiamos ativamente as seguintes plataformas, e pacotes estão disponíveis para algumas das opções abaixo: - Linux - - `.deb` and `.rpm` packages are built by CI for Debian and Red Hat-based - distributions - - Void and Arch packages also available within their respective repositories + - Os pacotes`.deb` e `.rpm` são criados pelo CI para distribuições baseadas no Debian e Red Hat + - Pacotes Void e Arch também disponíveis em seus respectivos repositórios - macOS - - `.pkg` packages are built by CI + - Pacotes`.pkg` são criados pelo CI - Ubiquiti EdgeOS - - `.deb` Vyatta packages are built by CI + - `.deb` Pacotes Vyatta são criados pelo CI - Windows - FreeBSD - OpenBSD - OpenWrt -Please see our [Platforms](https://yggdrasil-network.github.io/platforms.html) pages for more -specific information about each of our supported platforms, including -installation steps and caveats. +Consulte nossas páginas [Platforms](https://yggdrasil-network.github.io/platforms.html) para obter mais +informações específicas sobre cada uma de nossas plataformas suportadas, incluindo +etapas de instalação e advertências. -You may also find other platform-specific wrappers, scripts or tools in the -`contrib` folder. +Você também pode encontrar outros wrappers, scripts ou ferramentas específicos da plataforma na pasta `contrib`. -## Building +## Construção -If you want to build from source, as opposed to installing one of the pre-built -packages: +Se você deseja construir a partir do código-fonte, em vez de instalar um dos +pacotes: -1. Install [Go](https://golang.org) (requires Go 1.13 or later) -2. Clone this repository -2. Run `./build` +1. Instale [Go](https://golang.org) (requer Go 1.13 ou posterior) +2. Clonar este repositório +2. Execute `./build` -Note that you can cross-compile for other platforms and architectures by -specifying the `GOOS` and `GOARCH` environment variables, e.g. `GOOS=windows -./build` or `GOOS=linux GOARCH=mipsle ./build`. +Observe que você pode compilar de forma cruzada para outras plataformas e arquiteturas especificando as variáveis de ambiente `GOOS` and `GOARCH`, por exemplo `GOOS=windows +./build` ou `GOOS=linux GOARCH=mipsle ./build`. -## Running +## Executando -### Generate configuration +### Gerar configuração -To generate static configuration, either generate a HJSON file (human-friendly, -complete with comments): +Para gerar configuração estática, gere um arquivo HJSON (compatível com humanos, completo com comentários): ``` ./yggdrasil -genconf > /path/to/yggdrasil.conf ``` -... or generate a plain JSON file (which is easy to manipulate -programmatically): +... ou gere um arquivo JSON simples (fácil de manipular +programaticamente): ``` ./yggdrasil -genconf -json > /path/to/yggdrasil.conf ``` -You will need to edit the `yggdrasil.conf` file to add or remove peers, modify -other configuration such as listen addresses or multicast addresses, etc. +Você precisará editar o arquivo `yggdrasil.conf` para adicionar ou remover pares, modificar outras configurações, como endereços de escuta ou endereços multicast, etc. -### Run Yggdrasil +### Execute o Yggdrasil -To run with the generated static configuration: +Para executar com a configuração estática gerada: ``` ./yggdrasil -useconffile /path/to/yggdrasil.conf ``` -To run in auto-configuration mode (which will use sane defaults and random keys -at each startup, instead of using a static configuration file): +Para executar no modo de configuração automática (que usará padrões sãos e chaves aleatórias +em cada inicialização, em vez de usar um arquivo de configuração estática): ``` ./yggdrasil -autoconf ``` -You will likely need to run Yggdrasil as a privileged user or under `sudo`, -unless you have permission to create TUN/TAP adapters. On Linux this can be done -by giving the Yggdrasil binary the `CAP_NET_ADMIN` capability. +Você provavelmente precisará executar o Yggdrasil como um usuário privilegiado ou em `sudo`, +a menos que você tenha permissão para criar adaptadores TUN/TAP. No Linux, isso pode ser feito +dando ao binário Yggdrasil a capacidade `CAP_NET_ADMIN`. -## Documentation +## Documentação -Documentation is available on our [GitHub -Pages](https://yggdrasil-network.github.io) site, or in the base submodule -repository within `doc/yggdrasil-network.github.io`. +A documentação está disponível em nosso [GitHub +Pages](https://yggdrasil-network.github.io) ou no submódulo base +repositório dentro de `doc / yggdrasil-network.github.io`. -- [Configuration file options](https://yggdrasil-network.github.io/configuration.html) -- [Platform-specific documentation](https://yggdrasil-network.github.io/platforms.html) -- [Frequently asked questions](https://yggdrasil-network.github.io/faq.html) -- [Admin API documentation](https://yggdrasil-network.github.io/admin.html) +- [Opções do arquivo de configuração](https://yggdrasil-network.github.io/configuration.html) +- [Documentação específica da plataforma](https://yggdrasil-network.github.io/platforms.html) +- [Perguntas frequentes](https://yggdrasil-network.github.io/faq.html) +- [Documentação da API do administrador](https://yggdrasil-network.github.io/admin.html) - [Version changelog](CHANGELOG.md) -## Community +## Comunidade -Feel free to join us on our [Matrix -channel](https://matrix.to/#/#yggdrasil:matrix.org) at `#yggdrasil:matrix.org` -or in the `#yggdrasil` IRC channel on Freenode. +Sinta-se livre para se juntar a nós em nosso [canal Matrix](https://matrix.to/#/#yggdrasil:matrix.org) em `#yggdrasil:matrix.org` +ou no canal de IRC `#yggdrasil` no Freenode. -## License +## Licença -This code is released under the terms of the LGPLv3, but with an added exception -that was shamelessly taken from [godeb](https://github.com/niemeyer/godeb). -Under certain circumstances, this exception permits distribution of binaries -that are (statically or dynamically) linked with this code, without requiring -the distribution of Minimal Corresponding Source or Minimal Application Code. -For more details, see: [LICENSE](LICENSE). +Este código é lançado sob os termos do LGPLv3, mas com uma exceção adicional que foi descaradamente retirada de [godeb] (https://github.com/niemeyer/godeb). +Sob certas circunstâncias, essa exceção permite a distribuição de binários que estão (estaticamente ou dinamicamente) vinculados a esse código, sem exigir a distribuição do Minimal Corresponding Source ou Minimal Application Code. +Para mais detalhes, consulte: [LICENSE](LICENSE).