diff options
author | Tiago Gomes <tiago.gomes@codethink.co.uk> | 2018-09-28 11:24:44 +0100 |
---|---|---|
committer | Tiago Gomes <tiago.avv@gmail.com> | 2018-10-03 15:39:00 +0000 |
commit | 875496d2c50ecbb9defb964e1c10a66ae0c11b6b (patch) | |
tree | 15767dad33c92493b4a033634e26a5e94f6534e9 /doc/source/install_docker.rst | |
parent | 3247d22bcf8f6c90bc9fa131912408b8bd2141fc (diff) | |
download | buildstream-tiagogomes/docs-improvements.tar.gz |
doc: updates considering website being live nowtiagogomes/docs-improvements
* Add a link to the website on the main page.
* Remove install instructions as they are now on the website.
* Remove Resources section as that information can be found at the
website, and also looks bad.
* Move artifact server setup from the no longer existing Install section
to the Using section.
Diffstat (limited to 'doc/source/install_docker.rst')
-rw-r--r-- | doc/source/install_docker.rst | 45 |
1 files changed, 0 insertions, 45 deletions
diff --git a/doc/source/install_docker.rst b/doc/source/install_docker.rst deleted file mode 100644 index c1ca7a298..000000000 --- a/doc/source/install_docker.rst +++ /dev/null @@ -1,45 +0,0 @@ - - -.. _docker: - -BuildStream inside Docker -------------------------- -If your system cannot provide the base system requirements for BuildStream, then it is possible to run buildstream within a Docker image. - -The BuildStream project provides -`Docker images <https://hub.docker.com/r/buildstream/buildstream-fedora>`_ -containing BuildStream and its dependencies. -This gives you an easy way to get started using BuildStream on any Unix-like -platform where Docker is available, including Mac OS X. - -We recommend using the -`bst-here wrapper script <https://gitlab.com/BuildStream/buildstream/blob/master/contrib/bst-here>`_ -which automates the necessary container setup. You can download it and make -it executable like this: - -.. code:: bash - - mkdir -p ~/.local/bin - curl --get https://gitlab.com/BuildStream/buildstream/raw/master/contrib/bst-here > ~/.local/bin/bst-here - chmod +x ~/.local/bin/bst-here - -Check if ``~/.local/bin`` appears in your PATH environment variable -- if it -doesn't, you should -`edit your ~/.profile so that it does <https://stackoverflow.com/questions/14637979/>`_. - -Once the script is available in your PATH, you can run ``bst-here`` to open a -shell session inside a new container based off the latest version of the -buildstream-fedora Docker image. The current working directory will be mounted -inside the container at ``/src``. - -You can also run individual BuildStream commands as ``bst-here COMMAND``. For -example: ``bst-here show systems/my-system.bst``. Note that BuildStream won't -be able to integrate with Bash tab-completion if you invoke it in this way. - -Two Docker volumes are set up by the ``bst-here`` script: - - * ``buildstream-cache --`` mounted at ``~/.cache/buildstream`` - * ``buildstream-config --`` mounted at ``~/.config/`` - -These are necessary so that your BuildStream cache and configuration files -persist between invocations of ``bst-here``. |