Go to file
2013-04-24 06:58:49 -07:00
docs Sorting agenda items with nestedSortable. 2013-04-23 17:24:27 +02:00
extras fab command, to run scripts with the OpenSlides settings 2013-04-24 13:06:04 +02:00
openslides Set version to 1.4b1-dev 2013-04-24 15:50:49 +02:00
tests A lot of template improvements and translation fixes 2013-04-24 10:38:03 +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 Insert new app to upload files via the frontend. Let tornado server media files. Insert icon-mediafile css class. Insert extra_stylfiles context variable. 2013-03-18 21:44:02 +01:00
.travis.yml Use Fabric in travis and insert a fabfile for developers 2013-04-16 00:19:59 +02:00
AUTHORS Added Roland to AUTHORS file. (Thanks for contributing CKEditor support!) 2013-04-24 10:50:24 +02:00
CHANGELOG Set next release to 1.4. Added 1.3.1 CHANGELOG from stable/1.3.x branch 2013-01-09 21:40:54 +01:00
fabfile.py fab command, to run scripts with the OpenSlides settings 2013-04-24 13:06:04 +02:00
INSTALL.txt Updated README, INSTALL and THANKS for 1.4-alpha1 release. 2013-04-24 14:26:09 +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 Updated win32 portable build script. 2013-04-12 00:04:32 +02:00
README.txt Set version to 1.4b1-dev 2013-04-24 15:50:49 +02:00
requirements.txt fab command, to run scripts with the OpenSlides settings 2013-04-24 13:06:04 +02:00
setup.py fab command, to run scripts with the OpenSlides settings 2013-04-24 13:06:04 +02:00
start.py changed the main script 2012-08-14 14:19:59 +02:00
THANKS Updated README, INSTALL and THANKS for 1.4-alpha1 release. 2013-04-24 14:26:09 +02:00

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

This is OpenSlides, version 1.4-beta1-dev (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
==============================
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
    Shows all options

-a, --address=ADDRESS
    Changes the address on which the server will listen for connections

-p PORT, --port=PORT
    Changes the port on which the server will listen for connections

--syncdb
    Creates/updates database before starting the server

--reset-admin
    Resets the password to 'admin' for user 'admin'

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

--no-reload
    Does not reload the development server

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

--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 7+
  Chrome
  Safari