65 lines
1.7 KiB
Plaintext
65 lines
1.7 KiB
Plaintext
|
|
||
|
|
**XXX** Maybe add an introduction section (what is openslides, link to homepage, etc.)?
|
||
|
|
**XXX** Add a note that openslides should only be run on trusted networks
|
||
|
|
|
||
|
|
Getting started
|
||
|
|
===============
|
||
|
|
Simply running openslides.exe 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:
|
||
|
|
|
||
|
|
-a, --address=ADDRESS
|
||
|
|
Changes the address on which the server will listen for connections
|
||
|
|
|
||
|
|
-p, --port
|
||
|
|
Changes the port on which the server will listen for connections
|
||
|
|
|
||
|
|
--syncdb
|
||
|
|
Create/ update the database
|
||
|
|
|
||
|
|
--reset-admin
|
||
|
|
This will reset the password of the user
|
||
|
|
|
||
|
|
Example 1: Openslides should only be accessible on this computer:
|
||
|
|
openslides.exe -a 127.0.0.1
|
||
|
|
|
||
|
|
Example 2: Like above, but also specify the port as 8080
|
||
|
|
openslides.exe -a 127.0.0.01 -p 8080
|
||
|
|
|
||
|
|
|
||
|
|
Supported operating systems and browsers
|
||
|
|
========================================
|
||
|
|
Windows XP or newer (32 and 64bit)
|
||
|
|
**TODO** browsers
|
||
|
|
|
||
|
|
|
||
|
|
Included Packages
|
||
|
|
=================
|
||
|
|
${PACKAGE_LIST}
|
||
|
|
|
||
|
|
|
||
|
|
License
|
||
|
|
=======
|
||
|
|
openslides is distributed under the GNU General Public License
|
||
|
|
version 2. For details about this license and the licenses of the
|
||
|
|
bundled packages, please refer to the corresponding file in the
|
||
|
|
licenses/ directory.
|