Conference management site for FOSSY. Forked from Linux Australia's version at https://gitlab.com/laconfdev/symposion_app.
Find a file
Jamie Lennox 5c19dbf236 Specify how to create a superuser account in dev
To do development you will need a local super user account. This is
a standard Django practice but should be documented here as well.
2017-06-10 13:18:54 +10:00
docker Add populate_inventory to sqlite deploy script 2017-05-07 20:05:03 +10:00
fixtures Remove sponsor fixtures 2017-06-10 12:30:53 +10:00
pinaxcon Display failure messages when environment variables missing 2017-06-10 12:00:31 +10:00
static Add missing space to required * ::after 2017-05-07 13:40:36 +10:00
vendor Vendor registripe 2017-05-27 21:08:17 +10:00
.dockerignore Autodeploy the new sqlite database 2017-05-07 18:40:55 +10:00
.gitignore Prepare to vendor 2017-05-27 21:02:24 +10:00
.gitlab-ci.yml Lets try to automate this build a bit 2017-04-29 20:21:25 +10:00
constraints.txt Deps for registripe 2017-05-27 21:14:08 +10:00
dev-env.sh Add a dev-env.sh script you can source in dev 2017-06-10 12:15:53 +10:00
LICENSE Prepare to vendor 2017-05-27 21:02:24 +10:00
manage.py Initial commit of the PinaxCon demo site 2015-10-16 12:53:02 -05:00
README.rst Specify how to create a superuser account in dev 2017-06-10 13:18:54 +10:00
requirements.txt Deps for registripe 2017-05-27 21:14:08 +10:00
tox.ini Use full imports not . 2017-04-29 14:28:48 +10:00

symposion_app
===============

At this time, considerations have not been made to have the django project run
without additional infrastructure.

This can be configured in the future by switching the defualt
DEFAULT_FILE_STORAGE django default, and properly configuring django to load
subsequent configuration to switch this back to GCS on run in our testing
and production environments.

Login is a bit more complicated, the default flow redirects you out to a SAML
server, you can probably work something out with testshib.   But if you go to
/admin and log in, that will persist into /dashboard.


Required Configuration
----------------------

GCS
~~~

1. Set the bucket in settings.py
1. Store your Service Account JSON in a file
1. Set GOOGLE_APPLICATION_CREDENTIALS to your account file
1. Set GCS_BUCKET to your bucket name

SAML2
~~~~~

Please familurise yourself with Shibboleth configuraiton and the general
flow of how to register a SP with an IDP.

If you send the SP metadata staticly, validdity time must be removed.

You will also need to register your IDP metadata here either staticly or
remotely updated.

You may consider testing with testshib.

Configure signing and encryption keys, and configure them in the settings.py

VirtualEnv
~~~~~~~~~~

Not all things are lovely, so we use constraints to force the versions we
we wish for without having to do anything ugly.  This may require a newer
version of pip than is packaged with distros virtualenv

- ``virtualenv2 ve2``
- ``source ./ve2/bin/activate``
- ``pip install -c constraints.txt -r requirements.txt``

Pre-post-start configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Now that we are ready to start the app, we need to do initial setup, start
it, perform voodoo string magic, run more database jingling voodoo, and then
we can start it up and start looking around and customising the application.

``./manage.py migrate``
``./manage.py runserver``

Now we hit up the admin interface, find `symposion_proposals` `proposalkind`
and add `Talk` slug `talk`, `Tutorial`:`tutorial`, and `Miniconf`:`miniconf`.

Shut down and now run:
``./manage.py populate_inventory``

Now you can run the system and see how it goes.

Admin Credentials
~~~~~~~~~~~~~~~~~

To create a local administrator account run:

``./manage.py createsuperuser``

and enter your username, email and password. This can then be used to login to: (http://localhost:8000/admin).

Base Data
~~~~~~~~~

On initial creation and whenever you reset the database you must reload the
basic data. This data is stored in the /fixtures directory. You can load this with:

``./manage.py loaddata ./fixtures/*.json``