OpenSlides/README.md

84 lines
2.1 KiB
Markdown
Raw Normal View History

# OpenSlides
## 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
https://openslides.com for more information.
__Note: OpenSlides 4 is currently under development.__
2020-01-05 13:51:35 +01:00
## Architecture of OpenSlides 4
2020-01-05 13:51:35 +01:00
![System architecture of OpenSlides 4](docs/OpenSlides4-systemarchitecture.png)
2020-01-05 15:11:45 +01:00
Read more about our [concept of OpenSlides 4.0](https://github.com/OpenSlides/OpenSlides/wiki/DE%3A-Konzept-OpenSlides-4).
## Installation
### Requirements
2020-07-16 15:20:07 +02:00
You need [Docker](https://docs.docker.com/engine/install/) and [Docker
Compose](https://docs.docker.com/compose/install/).
### Setup OpenSlides
2021-05-01 11:15:03 +02:00
Go to a nice place in your filesystem, get the [OpenSlides manage
tool](https://github.com/OpenSlides/openslides-manage-service/releases/tag/latest)
from GitHub and make it executable. E. g. run:
$ wget https://github.com/OpenSlides/openslides-manage-service/releases/download/latest/manage
$ chmod +x manage
Create configuration files:
$ ./manage setup --cwd # TODO: Provide instruction using XDG_DATA_PATH.
Build and start Docker containers. According to your Docker installation you may
have to run this as root:
2021-04-30 11:19:21 +02:00
$ docker-compose up --detach
Setup initial-data:
$ ./manage initial-data
Now you can open https://localhost:8000 and use OpenSlides. # TODO: Enable HTTPS support
2020-10-05 10:43:43 +02:00
To stop OpenSlides run:
2020-10-05 10:43:43 +02:00
$ docker-compose stop
2020-10-05 10:43:43 +02:00
To remove all containers including the complete database run:
2020-10-05 10:43:43 +02:00
$ docker-compose rm
2020-10-05 10:43:43 +02:00
## Installation with ...
TODO: Provide a short instruction for setup with Docker Swarm or Kubernetes or
something else.
## Development setup
For a development setup, refer to [the development docs](DEVELOPMENT.md)
2020-10-05 10:43:43 +02:00
## Used software
OpenSlides uses the following projects or parts of them:
* Several Python packages (see TODO)
* Several JavaScript packages (see TODO)
* TODO
## License and authors
OpenSlides is Free/Libre Open Source Software (FLOSS), and distributed
under the MIT License, see ``LICENSE`` file. The authors of OpenSlides are
mentioned in the ``AUTHORS`` file.