README: Typos, language, formatting
This commit is contained in:
parent
13db5687cb
commit
774fa4c204
46
README.rst
46
README.rst
@ -5,16 +5,18 @@
|
|||||||
What is OpenSlides?
|
What is OpenSlides?
|
||||||
===================
|
===================
|
||||||
|
|
||||||
OpenSlides is a free, web based presentation and assembly system for
|
OpenSlides is a free, Web-based presentation and assembly system for
|
||||||
managing and projecting agenda, motions and elections of an assembly. See
|
managing and projecting agenda, motions, and elections of assemblies. See
|
||||||
https://openslides.com for more information.
|
https://openslides.com for more information.
|
||||||
|
|
||||||
Installation
|
Installation
|
||||||
============
|
============
|
||||||
|
|
||||||
The main deployment method is using docker and docker-compose. You just need
|
The main deployment method is using Docker and docker-compose. You only need to
|
||||||
both installed and no further dependencies. If you want a simpler setup or are
|
have these tools installed and no further dependencies. If you want a simpler
|
||||||
interesed in developing, please refer to `development instructions <https://github.com/OpenSlides/OpenSlides/blob/master/DEVELOPMENT.rst>`_.
|
setup or are interested in developing, please refer to `development
|
||||||
|
instructions
|
||||||
|
<https://github.com/OpenSlides/OpenSlides/blob/master/DEVELOPMENT.rst>`_.
|
||||||
|
|
||||||
Note: This is temporary and will be replace with nice scripts...
|
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
|
$ git clone https://github.com/OpenSlides/OpenSlides.git
|
||||||
$ cd OpenSlides/docker/
|
$ 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
|
$ ./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" \
|
$ printf "DJANGO_SECRET_KEY='%s'\n" \
|
||||||
"$(tr -dc 'a-zA-Z0-9' < /dev/urandom | head -c 64)" > secrets/django.env
|
"$(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
|
We also strongly recommend that you set a secure admin password but it is not
|
||||||
non-admin user. Both are not strictly required (and a missing admin password will print warnings on the
|
strictly required. If you do not set an admin password, the default login
|
||||||
startup), but if you want to have a secure setup, do::
|
credentials will be displayed on the login page. Setting the admin password::
|
||||||
|
|
||||||
$ cp secrets/admin.env.example secrets/admin.env
|
$ cp secrets/admin.env.example secrets/admin.env
|
||||||
$ cp secrets/user.env.example secrets/user.env
|
|
||||||
$ vi secrets/admin.env
|
$ vi secrets/admin.env
|
||||||
$ vi secrets/user.env
|
|
||||||
|
|
||||||
If the server and client are built, you can use ``docker-compose`` as usual
|
Afterwards, generate the configuration file::
|
||||||
(except for the ``build`` method)::
|
|
||||||
|
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
|
$ docker-compose up
|
||||||
$ # or:
|
$ # or:
|
||||||
@ -51,24 +56,23 @@ If the server and client are built, you can use ``docker-compose`` as usual
|
|||||||
$ # ...
|
$ # ...
|
||||||
$ docker-compose down
|
$ docker-compose down
|
||||||
|
|
||||||
OpenSlides is listening on port 8000. It can be changed in the
|
|
||||||
``docker/docker-compose.yml``.
|
|
||||||
|
|
||||||
Bugs, features and development
|
Bugs, features and development
|
||||||
================================
|
================================
|
||||||
|
|
||||||
Feel free to create issues here in GitHub! Please use the right templates for
|
Feel free to open issues here on GitHub! Please use the right templates for
|
||||||
bugs and features and using them correctly. Pull requests are also welcome; 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 <https://github.com/OpenSlides/OpenSlides/blob/master/DEVELOPMENT.rst>`_.
|
a general overview of the development setup refer the `development instructions
|
||||||
|
<https://github.com/OpenSlides/OpenSlides/blob/master/DEVELOPMENT.rst>`_.
|
||||||
|
|
||||||
Used software
|
Used software
|
||||||
=============
|
=============
|
||||||
|
|
||||||
OpenSlides uses the following projects or parts of them:
|
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
|
License and authors
|
||||||
===================
|
===================
|
||||||
|
Loading…
Reference in New Issue
Block a user