Go to file
Oskar Hahn 69ef67e729 Merge pull request #799 from normanjaeckel/WorkflowImage
Insert workflow overview image and table in German documentation
2013-07-05 08:04:01 -07:00
docs Insert workflow overview image and table in German documentation 2013-07-04 15:40:11 +02:00
extras Fix issues when starting portable from a non-ascii path 2013-06-25 22:23:30 +02:00
openslides Fixed motion pdf and template issues: 2013-06-28 12:43:58 +02:00
tests Fixes #765. Avoids the django AbstracUser username validator 2013-06-26 19:00:52 +02:00
.coveragerc reordered the tests 2012-11-24 15:00:17 +01:00
.gitattributes Fixed folder list for .gitattributes. 2012-10-31 09:06:56 +01:00
.gitignore Update all meta files. 2013-05-15 01:59:18 +02:00
.travis.yml Rename requrirements. This fixes #676. 2013-05-23 23:46:14 +02:00
AUTHORS Added Roland to AUTHORS file. (Thanks for contributing CKEditor support!) 2013-04-24 10:50:24 +02:00
CHANGELOG Updated CHANGELOG (fixed #699). 2013-07-02 09:19:25 +02:00
fabfile.py fab command, to run scripts with the OpenSlides settings 2013-04-24 13:06:04 +02:00
INSTALL.txt Rename requrirements. This fixes #676. 2013-05-23 23:46:14 +02:00
LICENSE changle end of line to windows for some files 2012-07-20 10:55:07 +02:00
manage.py fixed update of person_api 2013-03-14 22:32:00 +01:00
MANIFEST.in Fixed MANIFEST.in 2013-05-17 00:10:11 +02:00
README.txt Update version to 1.4-dev (final) 2013-06-17 20:19:02 +02:00
requirements_production.txt Update requirements 2013-06-03 19:30:04 +02:00
requirements.txt Some template and doc fixes 2013-06-25 22:15:51 +02:00
setup.py Fixed setup.py 2013-05-17 01:17:07 +02:00
start.py changed the main script 2012-08-14 14:19:59 +02:00
THANKS Fixed merge error. 2013-06-03 22:39:48 +02:00

====================================
 English README file for OpenSlides
====================================

This is OpenSlides, version 1.4 (unreleased).


What is OpenSlides?
===================

OpenSlides is a free web-based presentation and assembly system for
displaying and controlling of agenda, motions and elections of an assembly.

See http://openslides.org for more information.


Getting started
===============

Install and start OpenSlides as described in the INSTALL.txt.

If you need help please contact the OpenSlides team on public mailing
list or read the OpenSlides manual. See http://openslides.org.


The start script of OpenSlides
==============================

Start OpenSlides
----------------

Simply running
  openslides.exe (on Windows)
or
  openslides (on Linux/MacOS)

will start OpenSlides using djangos development server. It will also
try to open OpenSlides in your default webbrowser.

The server will listen on the IP address of your current hostname on
port 80 (if port 80 is not available port 8000 will be used).
This means that the server will be available to everyone on your
local network (at least for commonly used network configurations).

See `Command line options` below if you need to change this.

The login for the default admin user after (created on first start),
is as follows:

  Username: admin
  Password: admin


Command line options
--------------------

The following command line options are available:

-h, --help
    Show this help message and exit.

-a, --address=ADDRESS
    IP Address to listen on. Default: 0.0.0.0

-p PORT, --port=PORT
    Port to listen on. Default: 8000 (start as admin/root: 80)

--syncdb
    Update/create database before starting the server.

--backupdb=BACKUP_PATH
    Make a backup copy of the database to BACKUP_PATH.

--reset-admin
    Make sure the user 'admin' exists and uses 'admin' as
    password.

-s SETTINGS, --settings=SETTINGS
    Set the path to the settings file.

--no-browser
    Do not automatically start web browser.

--no-reload
    Do not reload the web server.

--no-run
    Do not start the web server.

--version
    Show version and exit.

Example 1: Openslides should only be accessible on this computer:
  openslides -a 127.0.0.1

Example 2: Like above, but also specify the port as 8080
  openslides -a 127.0.0.01 -p 8080


Supported operating systems and browsers
========================================

Operating Systems (OpenSlides runs anywhere where Pyhton is running):
  Windows XP or newer (32 and 64bit)
  MacOS X
  GNU/Linux

Browsers:
  Firefox 3.6+
  IE 8+
  Chrome
  Safari