diff --git a/docs/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md deleted file mode 100644 index aa0fcbf7b..000000000 --- a/docs/CODE_OF_CONDUCT.md +++ /dev/null @@ -1,46 +0,0 @@ -# Contributor Covenant Code of Conduct - -## Our Pledge - -In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. - -## Our Standards - -Examples of behavior that contributes to creating a positive environment include: - -* Using welcoming and inclusive language -* Being respectful of differing viewpoints and experiences -* Gracefully accepting constructive criticism -* Focusing on what is best for the community -* Showing empathy towards other community members - -Examples of unacceptable behavior by participants include: - -* The use of sexualized language or imagery and unwelcome sexual attention or advances -* Trolling, insulting/derogatory comments, and personal or political attacks -* Public or private harassment -* Publishing others' private information, such as a physical or electronic address, without explicit permission -* Other conduct which could reasonably be considered inappropriate in a professional setting - -## Our Responsibilities - -Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. - -Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. - -## Scope - -This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. - -## Enforcement - -Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at consul@madrid.es. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. - -Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. - -## Attribution - -This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version] - -[homepage]: http://contributor-covenant.org -[version]: http://contributor-covenant.org/version/1/4/ diff --git a/docs/CODE_OF_CONDUCT_ES.md b/docs/CODE_OF_CONDUCT_ES.md deleted file mode 100644 index 8153ebcba..000000000 --- a/docs/CODE_OF_CONDUCT_ES.md +++ /dev/null @@ -1,46 +0,0 @@ -# Código de Conducta convenido para Contribuyentes - -## Nuestro compromiso - -En el interés de fomentar una comunidad abierta y acogedora, nosotros como contribuyentes y administradores nos comprometemos a hacer de la participación en nuestro proyecto y nuestra comunidad una experiencia libre de acoso para todos, independientemente de la edad, dimensión corporal, discapacidad, etnia, identidad y expresión de género, nivel de experiencia, nacionalidad, apariencia física, raza, religión, identidad u orientación sexual. - -## Nuestros estándares - -Ejemplos de comportamiento que contribuyen a crear un ambiente positivo: - -* Uso de lenguaje amable e inclusivo -* Respeto a diferentes puntos de vista y experiencias -* Aceptación de críticas constructivas -* Enfocarse en lo que es mejor para la comunidad -* Mostrar empatía a otros miembros de la comunidad - -Ejemplos de comportamiento inaceptable por participantes: - -* Uso de lenguaje o imágenes sexuales y atención sexual no deseada -* Comentarios insultantes o despectivos (*trolling*) y ataques personales o políticos -* Acoso público o privado -* Publicación de información privada de terceros sin su consentimiento, como direcciones físicas o electrónicas -* Otros tipos de conducta que pudieran considerarse inapropiadas en un entorno profesional. - -## Nuestras responsabilidades - -Los administradores del proyecto son responsables de clarificar los estándares de comportamiento aceptable y se espera que tomen medidas correctivas y apropiadas en respuesta a situaciones de conducta inaceptable. - -Los administradores del proyecto tienen el derecho y la responsabilidad de eliminar, editar o rechazar comentarios, *commits*, código, ediciones de documentación, *issues*, y otras contribuciones que no estén alineadas con este Código de Conducta, o de prohibir temporal o permanentemente a cualquier colaborador cuyo comportamiento sea inapropiado, amenazante, ofensivo o perjudicial. - -## Alcance - -Este código de conducta aplica tanto a espacios del proyecto como a espacios públicos donde un individuo esté en representación del proyecto o comunidad. Ejemplos de esto incluye el uso de la cuenta oficial de correo electrónico, publicaciones a través de las redes sociales oficiales, o presentaciones con personas designadas en eventos *online* u *offline*. La representación del proyecto puede ser clarificada explicitamente por los administradores del proyecto. - -## Aplicación - -Ejemplos de abuso, acoso u otro tipo de comportamiento inaceptable puede ser reportado al equipo del proyecto en consul@madrid.es. Todas las quejas serán revisadas e investigadas, generando un resultado apropiado a las circunstancias. El equipo del proyecto está obligado a mantener confidencialidad de la persona que reportó el incidente. Detalles específicos acerca de las políticas de aplicación pueden ser publicadas por separado. - -Administradores que no sigan o que no hagan cumplir este Código de Conducta pueden ser eliminados de forma temporal o permanente del equipo administrador. - -## Atribución - -Este Código de Conducta es una adaptación del [Contributor Covenant][homepage], versión 1.4, disponible en [http://contributor-covenant.org/version/1/4/es/][version] - -[homepage]: http://contributor-covenant.org -[version]: http://contributor-covenant.org/version/1/4/es/ diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md deleted file mode 100644 index be1f2139a..000000000 --- a/docs/CONTRIBUTING.md +++ /dev/null @@ -1,58 +0,0 @@ -# Contributing - -We appreciate you want to help us by contributing to [Consul](https://github.com/consul/consul)'s Documentation. Here's a guide we made describing how to contribute changes to the project. - -## Code of conduct - -The core team members and the project's community adopts an inclusive Code of Conduct that you can read in the [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) file. - -## Reporting an issue and communications - -The prefered way to report any missing piece of information is [opening an issue in the project's Github repo](https://github.com/consul/docs/issues/new). For more informal communication, contact us through [consul's gitter](https://gitter.im/consul/consul) - -Before doing it, **please take some time to check the [existing issues](https://github.com/consul/docs/issues) and make sure what you are about to report isn't already reported** by another person. In case someone else reported the same problem before or a similar one, and you have more details about it, you can write a comment in the issue page... a little more help can make a huge difference! - -In order to write a new issue, take into account these few tips to make it easy to read and comprehend: - -- Try to use a descriptive and to-the-point title. -- It's a good idea to include some sections -in case they're needed- such as: steps to reproduce the bug, expected behaviour/response, actual response or screenshots. -- Also it could be helpful to provide your operating system, browser version and installed plugins. - -## Resolving an issue - -[Issues in Consul Docs](https://github.com/consul/docs/issues) labeled with `PRs-welcome` are well defined tasks ready to be documented by whoever wants to do it. In the other hand, the `not-ready` label marks tasks not well defined yet or subject to an internal decision, so we recommend not to try to resolve them until the core maintainers come to a resolution. - -We suggest to follow these steps to keep a good track of the changes you're about to make: - -- First of all, add a comment to any existing issue that your changes will address and resolve/close. If the issue has already someone assigned it means that person may be solving it, ask nicely about it. -- If there is no issue open about the changes you're going to make, sometimes makes sense to open it to start a little debate about it with other contributors and maintainers before the real work starts. Sometimes it prevents that debate from happening on the Pull Request comments, when it may be too late to revert some parts of the work done. -- [Fork the project](https://help.github.com/articles/fork-a-repo/) using your github account. -- Create a feature branch based on the `master` branch. To make it easier to identify, you can name it with the issue number followed by a concise and descriptive name (e.g. `123-fix_proposals_link`). -- Work in your branch committing there your changes. -- Once you've finished, send a **pull request** to the [Consul Docs repository](https://github.com/consul/docs/) describing your solution to help us understand it. It's also important to tell what issue you're addressing, so specify it in the pull request description's first line (e.g. `Fixes #123`). -- Core maintainers will review your PR and suggest changes if necessary. If everything looks good, your changes will be merged :) - -> **Working on your first Pull Request?** You can learn how from this *free* series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github). - -## How to contribute from your computer - -### Gitbooks - -This documentation is hosted online at [Gitbook](https://www.gitbook.com) for free, and its composed by [Markdown](https://es.wikipedia.org/wiki/Markdown) text files. Markdown its a lightweight markup language to give style to paragraphs, lists, etc... Check [Gitbook's Markdown syntax guide](https://toolchain.gitbook.com/syntax/markdown.html) - -To visualize on your browser how your changes would look you can use [https://github.com/GitbookIO/gitbook](https://github.com/GitbookIO/gitbook) to start a localhost server that will render the documentation. - -### Markdown Linter - -To maintain Markdown syntax consistency we use [Markdown Linter](https://github.com/markdownlint/markdownlint) and a `.mdlrc` file that holds its configuration on the project's root directory. - -To check your changes have no linting issues you first have to install the tool with `gem install mdl` and then execute it with `mdl .` - -## Other ways of contributing - -We'll appreciate any kind of contribution to Consul Docs. Even if you can't contribute to it writing new docs, you still can: - -- Create issues to notify the project owners with as much information as you can provide about anything wrong/missing you see, and someone will take care of it as soon as possible. -- Help translate existing documentation into a language that you master well enough. - -Gracias! ❤️❤️❤️ diff --git a/docs/CONTRIBUTING_ES.md b/docs/CONTRIBUTING_ES.md deleted file mode 100644 index 0eb0b0b74..000000000 --- a/docs/CONTRIBUTING_ES.md +++ /dev/null @@ -1,60 +0,0 @@ -# Contribuciones - -Te agradecemos que quieras colaborar contribuyendo a la Documentación de [Consul](https://github.com/consul/consul). Aquí tienes una guía donde consultar cómo sugerir cambios y mejoras al proyecto. - -## Código de Conducta - -Los miembros del proyecto y la comunidad de personas que contribuyen a él se adhieren a un código de conducta que se puede consultar en el archivo [CODE_OF_CONDUCT_ES.md](CODE_OF_CONDUCT_ES.md). - -## Reporte de incidencias y comunicación - -Si has visto alguna sección incompleta o ausente, te animamos a [abrir una incidencia en el repositorio de Documentación de Consul](https://github.com/consul/docs/issues/new). - -Para comunicaciones más informales, contacta con nosotros a través del [gitter de consul](https://gitter.im/consul/consul) - -Antes de hacerlo, **por favor tómate un tiempo para comprobar los [issues ya existentes](https://github.com/consul/docs/issues) y asegúrate de que lo que estás a punto de reportar no ha sido reportado previamente** por otra persona. De ser así, si tienes más detalles acerca de la incidencia puedes escribir un comentario en la página ‑¡un poco de ayuda puede marcar una gran diferencia! - -Para escribir un nuevo issue, ten en cuenta estas recomendaciones para hacerlo más fácil de leer y comprender: - -- Intenta usar un título descriptivo. -- Es buena idea incluir algunas secciones -en caso de que sean necesarias- como los pasos para reproducir el error, el comportamiento o respuesta que cabría esperar, la respuesta que devuelve o capturas de pantalla. -- También puede ser de ayuda incluir en la descripción tu sistema operativo, versión del navegador que usaste y posibles plugins instalados. - -## Resolver incidencias - -[Las incidencias en los Docs](https://github.com/consul/docs/issues) con la etiqueta `PRs-welcome` son tareas bien definidas que están listas para ser resueltas por cualquiera que se ofrezca a ello. Por otra parte, la etiqueta `not-ready` indica las tareas o cambios que aún están pendientes de concretar, por lo que recomendamos no intentar resolverlos hasta que los/as miembros/as del proyecto lleguen a una resolución. - -Te sugerimos seguir los siguientes pasos para facilitar el seguimiento de los cambios que vayas a hacer: - -- Primero, añade un comentario en la incidencia para notificar que vas resolverlo. Si el issue tiene a alguien asignado significa que ya hay alguien encargado de él. -- Si no existe una incidencia para la tarea que vas a resolver, puede ser una buena idea crearla para hablar en la página de la incidencia con el resto de la comunidad acerca de como afrontar la tarea. A veces ayuda a prevenir que el debate se produzca en la revisión del Pull Request, y la sensación de haber dedicado tiempo en trabajo en vano. -- Crea un fork del proyecto. -- Crea una rama de funcionalidad basada en la rama `master`. Para identificarla más fácilmente, puedes nombrarla con el número de incidencia seguido de un nombre conciso y descriptivo (por ejemplo: `123-fix_proposals_link`). -- Desarrolla los cambios haciendo commits en tu nueva rama. -- Cuando hayas terminado, envía un **pull request** al [repositorio de Consul](https://github.com/consul/docs/) describiendo la solución que propones para ayudarnos a entenderlo. También es importante que especifiques qué incidencia estás resolviendo al principio de la descripción del PR (por ejemplo, `Fixes #123`). -- El equipo de Consul revisará tu PR y podrá sugerir cambios si son necesarios. Una vez esté todo bien, tus cambios serán introducidos en el proyecto :) - -> **¿Es tu primer Pull Request?** Puedes aprender cómo contribuir a un proyecto en Github siguiendo los tutoriales [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github) (en inglés). - -## Cómo contribuir desde tu ordenador - -### Gitbooks - -Esta documentación se aloja online en [Gitbook](https://www.gitbook.com) de forma gratuita, y está formada de ficheros de texto [Markdown](https://es.wikipedia.org/wiki/Markdown). Markdown es un lenguage de marcado sencillo para dar estilo a párrafos, listas etc... Consulta [la guía de Gitbook sobre Markdown](https://toolchain.gitbook.com/syntax/markdown.html) - -Para visualizar en tu navegador como se verían tus cambios puedes usar [https://github.com/GitbookIO/gitbook](https://github.com/GitbookIO/gitbook) para levantar un servidor local que sirva la documentación. - -### Markdown Linter - -Para mantener la consistencia en la sintaxis de ficheros Markdown este proyecto usa [Markdown Linter](https://github.com/markdownlint/markdownlint) junto a un fichero de configuración `.mdlrc` en el directorio raiz. - -Para usarla instala la herramienta con `gem install mdl` y ejecuta después `mdl .` - -## Otras formas de contribuir - -Apreciaremos cualquier tipo de contribución a la Documentación de Consul. Incluso si no puedes contribuir a escribir nuevas secciones, puedes: - -- Crea una incidencia para notificar al resto de contribuidores con toda la información posible sobre lo que falta o esta incorrecto. -- Ayuda a traducir documentación existente a un idioma que domines suficientemente. - -Gracias! ❤️❤️❤️ diff --git a/docs/en/features/recomendations.md b/docs/en/features/recommendations.md similarity index 100% rename from docs/en/features/recomendations.md rename to docs/en/features/recommendations.md diff --git a/docs/en/forks/communication.md b/docs/en/getting_started/communication.md similarity index 100% rename from docs/en/forks/communication.md rename to docs/en/getting_started/communication.md diff --git a/docs/en/forks/configuration.md b/docs/en/getting_started/configuration.md similarity index 100% rename from docs/en/forks/configuration.md rename to docs/en/getting_started/configuration.md diff --git a/docs/en/forks/create.md b/docs/en/getting_started/create.md similarity index 100% rename from docs/en/forks/create.md rename to docs/en/getting_started/create.md diff --git a/docs/en/getting_started/prerequisites/README.md b/docs/en/getting_started/prerequisites/README.md deleted file mode 100644 index 57a419fcc..000000000 --- a/docs/en/getting_started/prerequisites/README.md +++ /dev/null @@ -1,7 +0,0 @@ -# Prerequisites Installation - -## [Linux](linux.html) - -## [macOS](macos.html) - -## [Windows](windows.html) diff --git a/docs/en/getting_started/prerequisites/linux.md b/docs/en/getting_started/prerequisites/linux.md deleted file mode 100644 index 52a7aa9cf..000000000 --- a/docs/en/getting_started/prerequisites/linux.md +++ /dev/null @@ -1,162 +0,0 @@ -# Configuration for development and test environments (GNU/Linux) - -## Git - -Git is officially maintained in Debian/Ubuntu: - -``` -sudo apt-get install git -``` - -## Ruby - -Ruby versions packaged in official repositories are not suitable to work with consul (at least Debian 7 and 8), so we'll have to install it manually. - -The preferred method is via rvm: - -(only the multi user option installs all dependencies automatically, as we use 'sudo'.) - -### As local user - -``` -curl -L https://get.rvm.io | bash -s stable -``` - -### For all system users - -``` -curl -L https://get.rvm.io | sudo bash -s stable -``` - -and then add your user to rvm group - -``` -sudo usermod -a -G rvm -``` - -and finally, add rvm script source to user's bash (~/.bashrc) (this step it's only necessary if you still can't execute rvm command) - -``` -[[ -s /usr/local/rvm/scripts/rvm ]] && source /usr/local/rvm/scripts/rvm -``` - -with all this, you are suppose to be able to install a ruby version from rvm, as for example version 2.3.0: - -``` -sudo rvm install 2.3.0 -``` - -## Bundler - -with - -``` -gem install bundler -``` - -or there is more methods [here](https://rvm.io/integration/bundler) that should be better as: - -``` -gem install rubygems-bundler -``` - -## Node.js - -To compile the assets, you'll need a JavaScript runtime. Node.js is the preferred option. As with Ruby, we don't recommend installing Node from your distro's repositories. - -To install it, you can use [n](https://github.com/tj/n) - -Run the following command on your terminal: - -``` -curl -L https://git.io/n-install | bash -s -- -y lts -``` - -And it will install the latest LTS (Long Term Support) Node version on your `$HOME` folder automatically (This makes use of [n-install](https://github.com/mklement0/n-install)) - -## PostgreSQL (>=9.4) - -PostgreSQL version 9.4 is not official in debian 7 (wheezy), in 8 it seems to be officially maintained. - -So you have to add a repository, the official postgresql works fine. - -Add the repository to apt, for example creating file */etc/apt/sources.list.d/pgdg.list* with: - -``` -deb http://apt.postgresql.org/pub/repos/apt/ wheezy-pgdg main -``` - -afterwards you'll have to download the key, and install it, by: - -``` -wget https://www.postgresql.org/media/keys/ACCC4CF8.asc -apt-key add ACCC4CF8.asc -``` - -and install postgresql - -``` -apt-get update -apt-get install postgresql-9.4 -``` - -## ChromeDriver - -To run E2E integration tests, we use Selenium along with Headless Chrome. - -On Debian-based distros, the process to get ChromeDriver up and running is not as straightforward as on Mac OS. - -To get it working, first install the following packages: - -```bash -sudo apt-get update && sudo apt-get install libxss1 libappindicator1 libindicator7 unzip -``` - -Then you need either Google Chrome or Chromium installed, both are valid. - -You can download the former from [here](https://www.google.com/chrome/index.html), while the latter can be installed with the following command: - -```bash -sudo apt-get install chromium -``` - -You can now proceed to install ChromeDriver. First, check out its latest version [here](https://sites.google.com/a/chromium.org/chromedriver/) - -Download it the following way: - -```bash -wget -N http://chromedriver.storage.googleapis.com/2.37/chromedriver_linux64.zip -``` - -Unzip it and make it executable like this: - -```bash -unzip chromedriver_linux64.zip -chmod +x chromedriver -``` - -Finally, add the binary to your `$PATH`: - -```bash -sudo mv -f chromedriver /usr/local/share/chromedriver -sudo ln -s /usr/local/share/chromedriver /usr/local/bin/chromedriver -sudo ln -s /usr/local/share/chromedriver /usr/bin/chromedriver -``` - -Make sure everything's working as expected by running the following command: - -```bash -chromedriver --version -``` - -You should receive an output with the latest version of ChromeDriver. If that's the case, you're good to go! - -If you happen to be on an Arch-based distro, installing `chromium` from the `extra` repo will do. - -There's also the option to only install ChromeDriver from AUR. If you're using `pacaur`, this will do: - -```bash -pacaur -S chromedriver -``` - -> Now you're ready to go get Consul [installed](../local_installation.html)!! diff --git a/docs/en/forks/update.md b/docs/en/getting_started/update.md similarity index 100% rename from docs/en/forks/update.md rename to docs/en/getting_started/update.md diff --git a/docs/en/getting_started/basic_configuration.md b/docs/en/installation/basic_configuration.md similarity index 100% rename from docs/en/getting_started/basic_configuration.md rename to docs/en/installation/basic_configuration.md diff --git a/docs/en/getting_started/create_deploy_user.md b/docs/en/installation/create_deploy_user.md similarity index 100% rename from docs/en/getting_started/create_deploy_user.md rename to docs/en/installation/create_deploy_user.md diff --git a/docs/en/getting_started/prerequisites/debian.md b/docs/en/installation/debian.md similarity index 97% rename from docs/en/getting_started/prerequisites/debian.md rename to docs/en/installation/debian.md index bf246b7b4..b8e1b927f 100644 --- a/docs/en/getting_started/prerequisites/debian.md +++ b/docs/en/installation/debian.md @@ -143,4 +143,4 @@ chromedriver --version You should receive an output with the latest version of ChromeDriver. If that's the case, you're good to go! -> Now you're ready to go get Consul [installed](../local_installation.html)!! +> Now you're ready to go get Consul [installed](local_installation.md)!! diff --git a/docs/en/getting_started/deploying-on-heroku.md b/docs/en/installation/deploying-on-heroku.md similarity index 100% rename from docs/en/getting_started/deploying-on-heroku.md rename to docs/en/installation/deploying-on-heroku.md diff --git a/docs/en/getting_started/dev_mailserver.md b/docs/en/installation/dev_mailserver.md similarity index 100% rename from docs/en/getting_started/dev_mailserver.md rename to docs/en/installation/dev_mailserver.md diff --git a/docs/en/getting_started/digital_ocean.md b/docs/en/installation/digital_ocean.md similarity index 100% rename from docs/en/getting_started/digital_ocean.md rename to docs/en/installation/digital_ocean.md diff --git a/docs/en/getting_started/docker.md b/docs/en/installation/docker.md similarity index 100% rename from docs/en/getting_started/docker.md rename to docs/en/installation/docker.md diff --git a/docs/en/getting_started/documentation_and_guides.md b/docs/en/installation/documentation_and_guides.md similarity index 100% rename from docs/en/getting_started/documentation_and_guides.md rename to docs/en/installation/documentation_and_guides.md diff --git a/docs/en/getting_started/generating_ssh_key.md b/docs/en/installation/generating_ssh_key.md similarity index 100% rename from docs/en/getting_started/generating_ssh_key.md rename to docs/en/installation/generating_ssh_key.md diff --git a/docs/en/getting_started/introduction.md b/docs/en/installation/introduction.md similarity index 55% rename from docs/en/getting_started/introduction.md rename to docs/en/installation/introduction.md index a7e7516da..918dc3dfd 100644 --- a/docs/en/getting_started/introduction.md +++ b/docs/en/installation/introduction.md @@ -4,8 +4,8 @@ These are our recommendations for the different environments and purposes: - To setup CONSUL for a production environment we recommend using the [installer](https://github.com/consul/installer). -- For developers working on a CONSUL fork we recommend using a UNIX based system (Linux or Mac) and installing CONSUL [locally system wide](https://consul_docs.gitbooks.io/docs/content/en/getting_started/prerequisites/). +- For developers working on a CONSUL fork we recommend using a UNIX based system (Linux or Mac) and installing CONSUL [locally system wide](local_installation.md). -- If you run into problems configuring CONSUL locally system wide and would like to show CONSUL for demo purposes we recommend using [Docker](https://consul_docs.gitbooks.io/docs/en/getting_started/docker.html) in a local machine. +- If you run into problems configuring CONSUL locally system wide and would like to show CONSUL for demo purposes we recommend using [Docker](docker.md) in a local machine. -- We also have a [Heroku guide](https://consul_docs.gitbooks.io/docs/content/en/getting_started/deploying-on-heroku.html) which can be used for demo purposes in a remote server. +- We also have a [Heroku guide](deploying-on-heroku.md) which can be used for demo purposes in a remote server. diff --git a/docs/en/getting_started/local_installation.md b/docs/en/installation/local_installation.md similarity index 96% rename from docs/en/getting_started/local_installation.md rename to docs/en/installation/local_installation.md index 165609225..b7fefaeee 100644 --- a/docs/en/getting_started/local_installation.md +++ b/docs/en/installation/local_installation.md @@ -1,6 +1,6 @@ # Local installation -Before installing Consul and having it up and running make sure you all [prerequisites](prerequisites) installed. +Before installing Consul and having it up and running make sure you all [prerequisites](prerequisites.md) installed. 1. First, clone the [Consul Github repository](https://github.com/consul/consul/): diff --git a/docs/en/getting_started/prerequisites/macos.md b/docs/en/installation/macos.md similarity index 100% rename from docs/en/getting_started/prerequisites/macos.md rename to docs/en/installation/macos.md diff --git a/docs/en/getting_started/servers.md b/docs/en/installation/servers.md similarity index 84% rename from docs/en/getting_started/servers.md rename to docs/en/installation/servers.md index e335f5a94..bc45864be 100644 --- a/docs/en/getting_started/servers.md +++ b/docs/en/installation/servers.md @@ -17,6 +17,3 @@ - Database: Postgres If your city has a population of over 1.000.000, consider balancing your load using 2-3 production servers and a separate server for the database. - -## Installation notes -Check out the [installer's README](https://github.com/consul/installer) diff --git a/docs/en/getting_started/prerequisites/ubuntu.md b/docs/en/installation/ubuntu.md similarity index 96% rename from docs/en/getting_started/prerequisites/ubuntu.md rename to docs/en/installation/ubuntu.md index 99cf4f558..04ee2668b 100644 --- a/docs/en/getting_started/prerequisites/ubuntu.md +++ b/docs/en/installation/ubuntu.md @@ -90,4 +90,4 @@ sudo apt install chromium-chromedriver sudo ln -s /usr/lib/chromium-browser/chromedriver /usr/local/bin/ ``` -Now you're ready to go [get CONSUL installed](../local_installation.html)! +Now you're ready to go [get CONSUL installed](local_installation.md)! diff --git a/docs/en/getting_started/using-aws-s3-as-storage.md b/docs/en/installation/using-aws-s3-as-storage.md similarity index 100% rename from docs/en/getting_started/using-aws-s3-as-storage.md rename to docs/en/installation/using-aws-s3-as-storage.md diff --git a/docs/en/getting_started/prerequisites/windows.md b/docs/en/installation/windows.md similarity index 100% rename from docs/en/getting_started/prerequisites/windows.md rename to docs/en/installation/windows.md diff --git a/docs/LICENSE b/docs/en/open_source/license.md similarity index 99% rename from docs/LICENSE rename to docs/en/open_source/license.md index dbbe35581..885dfe40c 100644 --- a/docs/LICENSE +++ b/docs/en/open_source/license.md @@ -1,6 +1,8 @@ - GNU AFFERO GENERAL PUBLIC LICENSE + GNU AFFERO GENERAL PUBLIC LICENSE Version 3, 19 November 2007 + Copyright (c) 2015 Ayuntamiento de Madrid + Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. @@ -633,8 +635,8 @@ the "copyright" line and a pointer to where the full notice is found. Copyright (C) This program is free software: you can redistribute it and/or modify - it under the terms of the GNU Affero General Public License as published - by the Free Software Foundation, either version 3 of the License, or + it under the terms of the GNU Affero General Public License as published by + the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, diff --git a/docs/es/forks/communication.md b/docs/es/getting_started/communication.md similarity index 100% rename from docs/es/forks/communication.md rename to docs/es/getting_started/communication.md diff --git a/docs/es/forks/configuration.md b/docs/es/getting_started/configuration.md similarity index 100% rename from docs/es/forks/configuration.md rename to docs/es/getting_started/configuration.md diff --git a/docs/es/forks/create.md b/docs/es/getting_started/create.md similarity index 100% rename from docs/es/forks/create.md rename to docs/es/getting_started/create.md diff --git a/docs/es/getting_started/prerequisites/README.md b/docs/es/getting_started/prerequisites/README.md deleted file mode 100644 index 6116a39a2..000000000 --- a/docs/es/getting_started/prerequisites/README.md +++ /dev/null @@ -1,8 +0,0 @@ -# Instalación de Prerrequisitos - -## [Linux](linux.html) - -## [macOS](macos.html) - -## [Windows](windows.html) - diff --git a/docs/es/getting_started/prerequisites/linux.md b/docs/es/getting_started/prerequisites/linux.md deleted file mode 100644 index e67ad1175..000000000 --- a/docs/es/getting_started/prerequisites/linux.md +++ /dev/null @@ -1,216 +0,0 @@ -# Configuración para los entornos de desarrollo y pruebas (GNU/Linux) - -## Git - -Git es mantenido oficialmente en Debian/Ubuntu: - -``` -sudo apt-get install git -``` - -## Ruby - -Las versiones de Ruby versions empaquetadas en repositorios oficiales no son aptas para trabajar con consul (al menos Debian 7 y 8), así que debemos instalar manualmente. - -El método recomendado es via rvm: - -(sólo la opción multiusuario instala todas las dependencias automáticamente, al usar 'sudo'.) - -### Como usuario local - -``` -curl -L https://get.rvm.io | bash -s stable -``` - -### Para todos los usuarios del sistema - -``` -curl -L https://get.rvm.io | sudo bash -s stable -``` - -añadismos nuestro usuario al grupo de rvm - -``` -sudo usermod -a -G rvm -``` - -y finalmente, añadimos el script rvm a nuestro bash (~/.bashrc) (este paso sólo es necesario si no puedes ejecutar el comando rvm) - -``` -[[ -s /usr/local/rvm/scripts/rvm ]] && source /usr/local/rvm/scripts/rvm -``` - -con todo esto, deberías poder instalar la versión de ruby con rvm, por ejemplo la 2.3.2: - -``` -sudo rvm install 2.3.2 -``` - -## Bundler - -usando - -``` -gem install bundler -``` - -hay varios métodos alternativos [aquí](https://rvm.io/integration/bundler) que podrían ser mejores como: - -``` -gem install rubygems-bundler -``` - -## Node.js - -Para compilar los archivos estáticos (JS, CSS, imágenes, etc.), es necesario un _runtime_ de JavaScript. Node.js es la opción recomendada. Al igual que como ocurre con Ruby, no es recomendable instalar Node directamente de los repositorios de tu distribución Linux. - -Para instalar Node, puedes usar [n](https://github.com/tj/n) - -Ejecuta el siguiente comando en tu terminal: - -``` -curl -L https://git.io/n-install | bash -s -- -y lts -``` - -Y este instalará automáticamente la versión LTS (_Long Term Support_, inglés para "Soporte a largo plazo") más reciente de Node en tu directorio `$HOME` (Este comando hace uso de [n-install](https://github.com/mklement0/n-install)) - -## PostgreSQL (>=9.4) - -La versión 9.4 de PostgreSQL no es oficial en Debian 7 (wheezy), pero en Debian 8 parece ser mantenida oficialmente. - -Así que debemos añadir el respositorio oficial de postgresql a apt, por ejemplo creando el fichero */etc/apt/sources.list.d/pgdg.list* con: - -``` -deb http://apt.postgresql.org/pub/repos/apt/ wheezy-pgdg main -``` - -después deberás descargar la key e instalarla: - -``` -wget https://www.postgresql.org/media/keys/ACCC4CF8.asc -apt-key add ACCC4CF8.asc -``` - -y finalmente instalar postgresql - -``` -apt-get update -apt-get install postgresql-9.4 -``` - -## Clonar el repositorio - -Ahora que ya tenemos todas las dependencias instalado podemos bajarnos el proyecto: - -``` -git clone https://github.com/consul/consul.git -cd consul -bundle install -cp config/database.yml.example config/database.yml -cp config/secrets.yml.example config/secrets.yml -``` - -Ahora copia en `database.yml` el usuario y la contraseña que pusiste para *consul*. Cuando ya lo hayas hecho: - -``` -rake db:create -rake db:setup -rake db:dev_seed -RAILS_ENV=test bin/rake db:setup -``` - -Para ejecutar los tests: - -``` -bundle exec rspec -``` - -Quizás necesites crear un rol de superusuario en postgresql, y completar en el fichero*/config/database.yml* los campos 'user:' y 'password:'. - -Además, parece que postgresql usa un socket unix por defecto para las comunicaciones en local. Si te encuentras este problema creando la base de datos, cambia en */config/database.yml* la linea: - -``` -host: localhost -``` - -por: - -``` -host: /var/run/postgresql -``` - -Tras esto en el terminal ejecutaremos: - -``` -rake db:create -rake db:setup -rake db:dev_seed -RAILS_ENV=test bin/rake db:setup -``` - -Y por último para comprobar que todo esta bien, lanza los tests: - -``` -bundle exec rspec -``` - -## ChromeDriver - -Para realizar pruebas de integración, usamos Selenium junto a Headless Chrome. - -En distribuciones basadas en Debian, el proceso de instalar ChromeDriver no es tan sencillo como en Mac OS. - -Para ello, primero instala los siguientes paquetes: - -```bash -sudo apt-get update && sudo apt-get install libxss1 libappindicator1 libindicator7 unzip -``` - -Ahora necesitarás Google Chrome o Chromium. Ambas opciones son válidas. - -Puedes instalar el primero haciendo click [acá](https://www.google.com/chrome/index.html), mientras que el segundo puede ser instalado de la siguiente manera: - -```bash -sudo apt-get install chromium -``` - -Ahora puedes instalar ChromeDriver. Primero, comprueba su última versión haciendo click [acá](https://sites.google.com/a/chromium.org/chromedriver/) - -Descárgalo ejecutando el siguiente comando: - -```bash -wget -N http://chromedriver.storage.googleapis.com/2.37/chromedriver_linux64.zip -``` - -Descomprimelo y hazlo ejecutable: - -```bash -unzip chromedriver_linux64.zip -chmod +x chromedriver -``` - -Finalmente, añade el binario a tu `$PATH`: - -```bash -sudo mv -f chromedriver /usr/local/share/chromedriver -sudo ln -s /usr/local/share/chromedriver /usr/local/bin/chromedriver -sudo ln -s /usr/local/share/chromedriver /usr/bin/chromedriver -``` - -Asegúrate de que todo funciona como es debido ejecutando el siguiente comando: - -```bash -chromedriver --version -``` - -Deberías recibir un mensaje indicando la última versión de ChromeDriver. Si ese es el caso, está todo listo - -Si te encuentras usando una distro basada en Arch, instalando `chromium` desde el repositorio `extra` debería ser suficiente - -También tienes la opción de solo instalar ChromeDriver desde AUR. Si usas `pacaur`, ejecuta el siguiente comando: - -```bash -pacaur -S chromedriver -``` - -> Ya estás listo para [instalar Consul](../local_installation.html)!! diff --git a/docs/es/forks/update.md b/docs/es/getting_started/update.md similarity index 100% rename from docs/es/forks/update.md rename to docs/es/getting_started/update.md diff --git a/docs/es/getting_started/basic_configuration.md b/docs/es/installation/basic_configuration.md similarity index 100% rename from docs/es/getting_started/basic_configuration.md rename to docs/es/installation/basic_configuration.md diff --git a/docs/es/getting_started/create_deploy_user.md b/docs/es/installation/create_deploy_user.md similarity index 100% rename from docs/es/getting_started/create_deploy_user.md rename to docs/es/installation/create_deploy_user.md diff --git a/docs/es/getting_started/prerequisites/debian.md b/docs/es/installation/debian.md similarity index 98% rename from docs/es/getting_started/prerequisites/debian.md rename to docs/es/installation/debian.md index 6ad322b7f..30eb6e68e 100644 --- a/docs/es/getting_started/prerequisites/debian.md +++ b/docs/es/installation/debian.md @@ -151,4 +151,4 @@ También tienes la opción de solo instalar ChromeDriver desde AUR. Si usas `pac pacaur -S chromedriver ``` -> Ya estás listo para [instalar Consul](../local_installation.html)!! +> Ya estás listo para [instalar Consul](local_installation.md)!! diff --git a/docs/es/installation/deploying-on-heroku.md b/docs/es/installation/deploying-on-heroku.md new file mode 100644 index 000000000..47fb23ae4 --- /dev/null +++ b/docs/es/installation/deploying-on-heroku.md @@ -0,0 +1,169 @@ +# Deploying on Heroku + +## Manual deployment + +This tutorial assumes that you have already managed to clone CONSUL on your machine and gotten it to work. + +1. First, create a [Heroku](https://www.heroku.com) account if it isn't already done. +2. Install the [Heroku CLI](https://devcenter.heroku.com/articles/heroku-cli) and sign in using + + ``` + heroku login + ``` + +3. Go to your CONSUL repository and instantiate the process + + ``` + cd consul + heroku create your-app-name + ``` + + You can add the flag `--region eu` if you want to use their European servers instead of the US ones. + + If _your-app-name_ is not already taken, Heroku should now create your app. + +4. Create a database using + + ``` + heroku addons:create heroku-postgresql + ``` + + You should now have access to an empty Postgres database whose address was automatically saved as an environment variable named _DATABASE\_URL_. CONSUL will automatically connect to it when deployed. + +5. Add a file name _heroku.yml_ at the root of your project and paste the following in it + + ``` + build: + languages: + - ruby + packages: + - imagemagick + run: + web: bundle exec rails server -e ${RAILS_ENV:-production} + ``` + +6. Now, generate a secret key and save it to an ENV variable named SECRET\_KEY\_BASE using + + ``` + heroku config:set SECRET_KEY_BASE=`ruby -rsecurerandom -e "puts SecureRandom.hex(64)" + ``` + + You need to let the app know where the secret key is stored by adding a link to the ENV variable in _config/secrets.yml_ + + ``` + production: + secret_key_base: <%= ENV["SECRET_KEY_BASE"] %> + ``` + + and commit this file in the repo by commenting out the corresponding line in the _.gitignore_. + + ``` + #/config/secrets.yml + ``` + + **Remember not to commit the file if you have any sensitive information in it!** + +7. You can now push your app using + + ``` + git push heroku your-branch:master + ``` + +8. It won't work straight away because the database doesn't contain the tables needed. To create them, run + + ``` + heroku run rake db:migrate + heroku run rake db:seed + ``` + + If you want to add the test data in the database, move `gem 'faker', '~> 1.8.7'` outside of `group :development` and run + + ``` + heroku config:set DATABASE_CLEANER_ALLOW_REMOTE_DATABASE_URL=true + heroku config:set DATABASE_CLEANER_ALLOW_PRODUCTION=true + heroku run rake db:dev_seed + ``` + +9. Your app should now be ready to use. You can open it with + + ``` + heroku open + ``` + + You also can run the console on heroku using + + ``` + heroku console --app your-app-name + ``` + +10. Heroku doesn't allow to save images or documents in its servers, so it's necessary make this changes + + On `app/models/image.rb:47` and `app/models/document.rb:39` + + Change `URI.parse(cached_attachment)` to `URI.parse("http:" + cached_attachment)` + + Create a new file on `config/initializers/paperclip.rb` with the following content + + ``` + Paperclip::UriAdapter.register + ``` + + See [our S3 guide](../getting_started/using-aws-s3-as-storage.md) for more details about configuring Paperclip with S3. + +### Optional but recommended: + +**Install rails\_12factor and specify the Ruby version** + +As recommended by Heroku, you can add the gem rails\_12factor and specify the version of Ruby you want to use. You can do so by adding + +``` +gem 'rails_12factor' + +ruby '2.3.2' +``` + +in the file _Gemfile\_custom_. Don't forget to run + +``` +bundle install +``` + +to generate _Gemfile.lock_ before commiting and pushing to the server. + +### Optional but recommended: + +**Use Puma as a web server** + +Heroku recommends to use Puma instead of the default web server to improve the responsiveness of your app on [a number of levels](http://blog.scoutapp.com/articles/2017/02/10/which-ruby-app-server-is-right-for-you). First, add the gem in your _Gemfile\_custom_ file: + + ``` + gem 'puma' + ``` + +Then you need to create a new file named _puma.rb_ \(your _config_ folder is a good place to store it\). Here is a standard content for this file: + + ``` + workers Integer(ENV['WEB_CONCURRENCY'] || 1) + threads_count = Integer(ENV['RAILS_MAX_THREADS'] || 5) + threads threads_count, threads_count + + preload_app! + + rackup DefaultRackup + port ENV['PORT'] || 3000 + environment ENV['RACK_ENV'] || 'production' + + on_worker_boot do + # Worker specific setup for Rails 4.1+ + # See: https://devcenter.heroku.com/articles/deploying-rails-applications-with-the-puma-web-server#on-worker-boot + ActiveRecord::Base.establish_connection + end + ``` + +You can find an explanation for each of these settings in the [Heroku tutorial](https://devcenter.heroku.com/articles/deploying-rails-applications-with-the-puma-web-server). + +The last part is to change the _web_ task to use Puma by changing it to this in your _heroku.yml_ file: + + ``` + web: bundle exec puma -C config/puma.rb + ``` diff --git a/docs/es/getting_started/dev_mailserver.md b/docs/es/installation/dev_mailserver.md similarity index 100% rename from docs/es/getting_started/dev_mailserver.md rename to docs/es/installation/dev_mailserver.md diff --git a/docs/es/getting_started/digital_ocean.md b/docs/es/installation/digital_ocean.md similarity index 100% rename from docs/es/getting_started/digital_ocean.md rename to docs/es/installation/digital_ocean.md diff --git a/docs/es/getting_started/docker.md b/docs/es/installation/docker.md similarity index 100% rename from docs/es/getting_started/docker.md rename to docs/es/installation/docker.md diff --git a/docs/es/getting_started/documentation_and_guides.md b/docs/es/installation/documentation_and_guides.md similarity index 100% rename from docs/es/getting_started/documentation_and_guides.md rename to docs/es/installation/documentation_and_guides.md diff --git a/docs/es/getting_started/generating_ssh_key.md b/docs/es/installation/generating_ssh_key.md similarity index 100% rename from docs/es/getting_started/generating_ssh_key.md rename to docs/es/installation/generating_ssh_key.md diff --git a/docs/es/getting_started/introduction.md b/docs/es/installation/introduction.md similarity index 52% rename from docs/es/getting_started/introduction.md rename to docs/es/installation/introduction.md index 18a513f0e..4c44fef6f 100644 --- a/docs/es/getting_started/introduction.md +++ b/docs/es/installation/introduction.md @@ -4,8 +4,8 @@ Estas son nuestras recomendaciones para los diferentes entornos y propósitos: - Para configurar CONSUL para un entorno de producción, recomendamos utilizar el [instalador](https://github.com/consul/installer). -- Para los programadores que trabajan en un entorno de desarrollo, recomendamos instalar CONSUL en un sistema basado en UNIX (Linux o Mac) y hacer una [instalación local](https://consul_docs.gitbooks.io/docs/content/en/getting_started/prerequisites/) de CONSUL. +- Para los programadores que trabajan en un entorno de desarrollo, recomendamos instalar CONSUL en un sistema basado en UNIX (Linux o Mac) y hacer una [instalación local](local_installation.md) de CONSUL. -- Si tienes problemas para hacer una instalación local y deseas mostrar CONSUL para fines de demostración, te recomendamos que utilices [Docker](https://consul_docs.gitbooks.io/docs/en/getting_started/docker.html) en tu ordenador personal. +- Si tienes problemas para hacer una instalación local y deseas mostrar CONSUL para fines de demostración, te recomendamos que utilices [Docker](docker.md) en tu ordenador personal. -- También tenemos una [Guía Heroku](https://consul_docs.gitbooks.io/docs/content/en/getting_started/deploying-on-heroku.html) que se puede utilizar para fines de demostración en un servidor remoto. +- También tenemos una [Guía Heroku](deploying-on-heroku.md) que se puede utilizar para fines de demostración en un servidor remoto. diff --git a/docs/es/getting_started/local_installation.md b/docs/es/installation/local_installation.md similarity index 96% rename from docs/es/getting_started/local_installation.md rename to docs/es/installation/local_installation.md index 27be3cbfd..99a2ae1f5 100644 --- a/docs/es/getting_started/local_installation.md +++ b/docs/es/installation/local_installation.md @@ -1,6 +1,6 @@ # Instalación local -Antes de comenzar a instalar Consul, comprueba que tengas todos los [prerrequisitos](prerequisites) correctamente instalados. +Antes de comenzar a instalar Consul, comprueba que tengas todos los [prerrequisitos](prerequisites.md) correctamente instalados. 1. Primero, clona el [repositorio de Consul en Github](https://github.com/consul/consul/): diff --git a/docs/es/getting_started/prerequisites/macos.md b/docs/es/installation/macos.md similarity index 100% rename from docs/es/getting_started/prerequisites/macos.md rename to docs/es/installation/macos.md diff --git a/docs/es/getting_started/servers.md b/docs/es/installation/servers.md similarity index 76% rename from docs/es/getting_started/servers.md rename to docs/es/installation/servers.md index 57385b0f7..b8a88d848 100644 --- a/docs/es/getting_started/servers.md +++ b/docs/es/installation/servers.md @@ -1,4 +1,4 @@ -# Servidores de prueba y producción +# Servidores de producción y pruebas ## Requisitos de sistema mínimos recomendados: @@ -17,6 +17,3 @@ - Database: Postgres Si tu ciudad tiene una población superior a 1.000.000, considera añadir un balanceador de carga y usar 2-3 servidores de producción, además de un servidor de base de datos dedicado. - -## Instrucciones de instalación -Se encuentran en el [repositorio del instalador](https://github.com/consul/installer) diff --git a/docs/es/getting_started/prerequisites/ubuntu.md b/docs/es/installation/ubuntu.md similarity index 97% rename from docs/es/getting_started/prerequisites/ubuntu.md rename to docs/es/installation/ubuntu.md index e0062ab36..4c31d3a82 100644 --- a/docs/es/getting_started/prerequisites/ubuntu.md +++ b/docs/es/installation/ubuntu.md @@ -90,4 +90,4 @@ sudo apt install chromium-chromedriver sudo ln -s /usr/lib/chromium-browser/chromedriver /usr/local/bin/ ``` -¡Ya estás listo para [instalar CONSUL](../local_installation.html)! +¡Ya estás listo para [instalar CONSUL](local_installation.md)! diff --git a/docs/es/getting_started/prerequisites/windows.md b/docs/es/installation/windows.md similarity index 100% rename from docs/es/getting_started/prerequisites/windows.md rename to docs/es/installation/windows.md diff --git a/docs/es/open_source/license.md b/docs/es/open_source/license.md new file mode 100644 index 000000000..885dfe40c --- /dev/null +++ b/docs/es/open_source/license.md @@ -0,0 +1,663 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (c) 2015 Ayuntamiento de Madrid + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. diff --git a/docs/consul_logo.png b/docs/img/consul_logo.png similarity index 100% rename from docs/consul_logo.png rename to docs/img/consul_logo.png