OpenSlides/README.txt

106 lines
2.5 KiB
Plaintext
Raw Normal View History

2013-04-25 13:10:50 +02:00
====================================
English README file for OpenSlides
====================================
2013-06-04 01:05:15 +02:00
This is OpenSlides, version 1.4rc1 (unreleased).
What is OpenSlides?
===================
2013-04-25 13:10:50 +02:00
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
===============
2013-04-25 13:10:50 +02:00
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
==============================
2013-04-25 13:10:50 +02:00
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
--------------------
2013-04-25 13:10:50 +02:00
The following command line options are available:
2012-10-30 20:05:54 +01:00
-h, --help
Shows all options
-a, --address=ADDRESS
Changes the address on which the server will listen for connections
2012-10-30 20:05:54 +01:00
-p PORT, --port=PORT
Changes the port on which the server will listen for connections
--syncdb
2012-10-30 20:05:54 +01:00
Creates/updates database before starting the server
--reset-admin
2012-10-30 20:05:54 +01:00
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
========================================
2013-04-25 13:10:50 +02:00
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