summaryrefslogtreecommitdiff
path: root/docker/README.rst
diff options
context:
space:
mode:
authorIvan Alejandro <ivanalejandro0@gmail.com>2015-09-10 17:32:40 -0300
committerKali Kaneko <kali@leap.se>2015-09-10 22:25:25 -0400
commit557f05cc3a9a767068cc6338dca6c9216200f390 (patch)
treeee440bab13a63fdafd39afe1b55a463fc2ed70e2 /docker/README.rst
parent580ad326c319113b85c85ce417e461acf15d36fe (diff)
[docs] add some docs for new docker stuff
- Resolves: #7446
Diffstat (limited to 'docker/README.rst')
-rw-r--r--docker/README.rst49
1 files changed, 49 insertions, 0 deletions
diff --git a/docker/README.rst b/docker/README.rst
new file mode 100644
index 00000000..dcad0ac6
--- /dev/null
+++ b/docker/README.rst
@@ -0,0 +1,49 @@
+Bitmask and Docker
+==================
+
+Here we have several tools that leverages docker to ease Bitmask testing.
+
+``bitmask-docker.sh`` is a helper script to ``build`` and ``run`` the bitmask app,
+here is an example usage::
+
+ $ ./bitmask-docker build # build docker image
+ $ ./bitmask-docker init ro bitmask-nightly.json # initialize all the stuff needed
+ # ....
+ $ ./bitmask-docker.sh run
+
+
+``bitmask-nightly.json`` is the version specifier for each bitmask component that
+will be used to run bitmask.
+
+``Dockerfile`` is the file used to build the docker image that will run bitmask.
+
+``leap_bootstrap.sh`` is the script that takes care of cloning repos, installing
+python dependencies, running bitmask, etc.
+
+
+debian/
+-------
+
+``apt-bitmask.sh`` script that installs bitmask from the debian packages.
+
+``bitmask-on-docker.sh`` installs bitmask and runs it in a dummy X server,
+waits a little and takes a screenshot.
+
+``leap-experimental.key`` is needed by ``apt-bitmask.sh`` to ``apt-key add``
+and verify apt sources.
+
+``run-docker-for-bitmask.sh`` is a helper script that runs an ubuntu/debian
+container ready to run the ``apt-bitmask.sh`` command, it does (among other
+stuff) X11 forwarding to display Bitmask UI on the host linux.
+
+An example usage::
+
+ $ ./run-docker-for-bitmask.sh
+ non-network local connections being added to access control list
+ root@hostname:/# cd /host/
+ root@hostname:/host# ./apt-bitmask.sh unstable
+ # [... not so relevant output ...]
+ root@hostname:/host# apt-get install -y lxpolkit # install a small polkit agent
+ # [... not so relevant output ...]
+ root@hostname:/host# lxpolkit & # run the polkit agent in the background, ignore the "No session for pid 6034" error.
+ root@hostname:/host# bitmask -d # tadaa, you have bitmask running in a container!