diff --git a/README.rst b/README.rst index 3991557b9..8abc3eccf 100644 --- a/README.rst +++ b/README.rst @@ -5,16 +5,18 @@ What is OpenSlides? =================== -OpenSlides is a free, web based presentation and assembly system for -managing and projecting agenda, motions and elections of an assembly. See +OpenSlides is a free, Web-based presentation and assembly system for +managing and projecting agenda, motions, and elections of assemblies. See https://openslides.com for more information. Installation ============ -The main deployment method is using docker and docker-compose. You just need -both installed and no further dependencies. If you want a simpler setup or are -interesed in developing, please refer to `development instructions `_. +The main deployment method is using Docker and docker-compose. You only need to +have these tools installed and no further dependencies. If you want a simpler +setup or are interested in developing, please refer to `development +instructions +`_. Note: This is temporary and will be replace with nice scripts... @@ -23,7 +25,8 @@ First, you have to clone this repository:: $ git clone https://github.com/OpenSlides/OpenSlides.git $ cd OpenSlides/docker/ -You need to build the docker images for the client and server with this script:: +You need to build the Docker images for the client and server with this +script:: $ ./build.sh @@ -32,17 +35,19 @@ You must define a Django secret key in ``secrets/django.env``, for example:: $ printf "DJANGO_SECRET_KEY='%s'\n" \ "$(tr -dc 'a-zA-Z0-9' < /dev/urandom | head -c 64)" > secrets/django.env -We strongly recomment to set an initial admin password and create a second -non-admin user. Both are not strictly required (and a missing admin password will print warnings on the -startup), but if you want to have a secure setup, do:: +We also strongly recommend that you set a secure admin password but it is not +strictly required. If you do not set an admin password, the default login +credentials will be displayed on the login page. Setting the admin password:: $ cp secrets/admin.env.example secrets/admin.env - $ cp secrets/user.env.example secrets/user.env $ vi secrets/admin.env - $ vi secrets/user.env -If the server and client are built, you can use ``docker-compose`` as usual -(except for the ``build`` method):: +Afterwards, generate the configuration file:: + + EXTERNAL_HTTP_PORT=8000 m4 docker-compose.yml.m4 > docker-compose.yml + +Once the server and client have been built, you can use ``docker-compose`` as +usual (except for the ``build`` method):: $ docker-compose up $ # or: @@ -51,24 +56,23 @@ If the server and client are built, you can use ``docker-compose`` as usual $ # ... $ docker-compose down -OpenSlides is listening on port 8000. It can be changed in the -``docker/docker-compose.yml``. - Bugs, features and development ================================ -Feel free to create issues here in GitHub! Please use the right templates for -bugs and features and using them correctly. Pull requests are also welcome; for -a general overview of the development setup refer the `development instructions `_. +Feel free to open issues here on GitHub! Please use the right templates for +bugs and features, and use them correctly. Pull requests are also welcome; for +a general overview of the development setup refer the `development instructions +`_. Used software ============= OpenSlides uses the following projects or parts of them: -* Several Python packages (see ``server/requirements/production.txt`` and ``server/requirements/big_mode.txt``). +* several Python packages (see ``server/requirements/production.txt`` and + ``server/requirements/big_mode.txt``) -* Several JavaScript packages (see ``client/package.json``) +* several JavaScript packages (see ``client/package.json``) License and authors ===================