Go to file
Finn Stutzenstein 6b218e3c7f
Add a CI check to verify that migrating the initial data works
2021-08-18 11:58:20 +02:00
.github Add a CI check to verify that migrating the initial data works 2021-08-18 11:58:20 +02:00
dev-commands Update manage service 2021-05-17 00:17:26 +02:00
docker Update Submodules to enable migrations 2021-08-17 11:37:15 +02:00
docs Issue6204: Define fields for archiving of meetings 2021-08-17 09:03:03 +02:00
logo Updated improved OpenSlides logo. 2019-09-13 13:25:41 +02:00
openslides-auth-service@205a8333ed Updated os4 services 2021-08-05 20:55:12 +02:00
openslides-autoupdate-service@fa7f9e92c6 Updated os4 services 2021-08-05 20:55:12 +02:00
openslides-backend@f575b5fefc Add a CI check to verify that migrating the initial data works 2021-08-18 11:58:20 +02:00
openslides-client@cc5c714117 Update Submodules to enable migrations 2021-08-17 11:37:15 +02:00
openslides-datastore-service@25233066f2 Update Submodules to enable migrations 2021-08-17 11:37:15 +02:00
openslides-icc-service@6dbc589b80 Updated os4 services 2021-08-05 20:55:12 +02:00
openslides-manage-service@74460b6999 Updated os4 services 2021-07-14 21:01:19 +02:00
openslides-media-service@6db3ecb09e Update 2021-02-04 15:35:15 +01:00
openslides-permission-service@4b058fe85f Updated os4 services 2021-06-28 12:05:04 +02:00
proxy Add ICC Service 2021-06-29 20:20:59 +02:00
.gitignore OS4 productive setup changes 2021-04-08 12:52:59 +02:00
.gitmodules Updated services 2021-06-30 14:31:30 +02:00
AUTHORS changed email 2019-08-08 08:07:29 +02:00
CHANGELOG.md Prepared repository for OpenSlides 4. Removed OpenSlides 3 code. 2020-01-05 14:16:23 +01:00
DEVELOPMENT.md Add https-info and enhance work-in-submodules doc 2020-08-14 11:09:49 +02:00
LICENSE Prepared repository for OpenSlides 4. Removed OpenSlides 3 code. 2020-01-05 14:16:23 +01:00
Makefile Update Backend 2021-08-06 11:14:30 +02:00
README.md Moved production setup to manage service. 2021-08-08 18:01:53 +02:00
db.sh Permission Service 2020-11-17 07:49:14 +01:00
dc-dev.sh Prod setup 2020-10-28 08:46:03 +01:00

README.md

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.

Architecture of OpenSlides 4

System architecture of OpenSlides 4

Read more about our concept of OpenSlides 4.0.

Installation

Requirements

You need Docker and Docker Compose.

Setup OpenSlides

Go to a nice place in your filesystem, get the OpenSlides manage tool 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:

$ docker-compose up --detach

Setup initial-data:

$ ./manage initial-data

Now you can open https://localhost:8000 and use OpenSlides. # TODO: Enable HTTPS support

To stop OpenSlides run:

$ docker-compose stop

To remove all containers including the complete database run:

$ docker-compose rm

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

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.