doc: typos and style fixes

This commit is contained in:
pancho horrillo
2019-12-10 16:09:35 +01:00
parent 84e481f78f
commit b4bc08f491
4 changed files with 90 additions and 50 deletions
@@ -1,7 +1,7 @@
Installing Kapow!
=================
*Kapow!* has a reference implementation in ``Go`` that is under active development
*Kapow!* has a reference implementation in *Go* that is under active development
right now. If you want to start using *Kapow!* you can choose from several
options.
@@ -20,7 +20,7 @@ Linux
Install the downloaded binary using the following command as a privileged user.
.. code-block:: bash
.. code-block:: console
$ install -t /usr/local/bin/kapow path_to_downloaded_binary
@@ -32,22 +32,50 @@ Copy the downloaded binary to a directory of your choice and update the system
``PATH`` variable to include that directory.
Install the package with go get
-------------------------------
Install the package with ``go get``
-----------------------------------
If you already have `installed and configured <https://golang.org/cmd/go/>`_
the ``go`` runtime in the host where you want to run *Kapow!*, simply run:
.. code-block:: bash
.. code-block:: console
$ go get -u github.com/BBVA/kapow
$ go get -v github.com/BBVA/kapow
Note that *Kapow!* leverages *Go modules*, so you can target specific releases:
.. code-block:: console
$ GO111MODULE=on go get -v github.com/BBVA/kapow@v0.3.0-rc4
go: finding github.com v0.3.0-rc4
go: finding github.com/BBVA v0.3.0-rc4
go: finding github.com/BBVA/kapow v0.3.0-rc4
go: downloading github.com/BBVA/kapow v0.3.0-rc4
go: extracting github.com/BBVA/kapow v0.3.0-rc4
github.com/google/shlex
github.com/google/uuid
github.com/spf13/pflag
github.com/BBVA/kapow/internal/server/httperror
github.com/BBVA/kapow/internal/http
github.com/BBVA/kapow/internal/server/model
github.com/BBVA/kapow/internal/client
github.com/gorilla/mux
github.com/BBVA/kapow/internal/server/user/spawn
github.com/BBVA/kapow/internal/server/data
github.com/BBVA/kapow/internal/server/user/mux
github.com/BBVA/kapow/internal/server/user
github.com/BBVA/kapow/internal/server/control
github.com/spf13/cobra
github.com/BBVA/kapow/internal/server
github.com/BBVA/kapow/internal/cmd
github.com/BBVA/kapow
Include *Kapow!* in your Container Image
----------------------------------------
If you want to include *Kapow!* in a ``Docker`` image you can add the binary
directly from the releases section. Following is an example ``Dockerfile`` that
If you want to include *Kapow!* in a ``Docker`` image, you can add the binary
directly from the releases section. Below is an example ``Dockerfile`` that
includes *Kapow!*.
.. code-block:: dockerfile
@@ -63,15 +91,15 @@ includes *Kapow!*.
ENTRYPOINT ["/usr/bin/kapow"]
If the container is intended for running the server and you want to dinamically
configure it, remember to include a `--control-bind` param with an external bind
address (i.e. ``0.0.0.0``) and to map all the needed ports in order to get access
to the control interface.
configure it, remember to include a ``--control-bind`` param with an external
bind address (e.g., ``0.0.0.0``) and to map all the needed ports in order to get
access to the control interface.
After building the image you can run the container with:
.. code-block:: bash
.. code-block:: console
$ docker run --rm -i -p 8080:8080 -v $(pwd)/whatever.pow:/opt/whatever.pow kapow:latest server /opt/whatever.pow
With the `-v` parameter we map a local file into the container's filesystem so
With the ``-v`` parameter we map a local file into the container's filesystem so
we can use it to configure our *Kapow!* server on startup.