Skip to content

Commit

Permalink
Update README to use docker setup instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
phlax committed May 23, 2019
1 parent 742c08f commit f9eca6d
Showing 1 changed file with 34 additions and 5 deletions.
39 changes: 34 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,16 +30,45 @@ Pootle. Teams can manage their files, permissions, projects, and translate
on-line. Files can be downloaded for offline translation.


Installation
Getting started
---------------

The easiest way to get started is by using the docker demo. You will need docker
installed on your system, and to be running as a user with permissions to manage
docker.

As the docker compose configuration is stored in the pootle directory, you will
need ``git`` installed and ``pip`` for some minimal python dependencies to get
set up.


Virtualenv
----------

You can optionally use a virtualenv to install the python requirements. This
will make it easier to install and run as a user other than ``root``


Demo install
------------

First install the requirements

::

git clone https://github.com/translate/pootle
cd pootle
pip install -r requirements/host.txt

You can now run the demo, using the ``makey`` command runner

::

pip install --pre Pootle
makey demo

Don't forget to read the `installation guide
<http://docs.translatehouse.org/projects/pootle/en/latest/server/installation.html>`_
for important details.
This will take a few moments to pull the required docker images, and
once up you should be able to browse to your pootle server on
http://localhost:8000


Copying
Expand Down

0 comments on commit f9eca6d

Please sign in to comment.