Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
P
PEDASI
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Deploy
Releases
Model registry
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Research Software Group
PEDASI
Commits
ec02c5cb
Commit
ec02c5cb
authored
6 years ago
by
James Graham
Browse files
Options
Downloads
Patches
Plain Diff
Fill in deployment instructions on admin docs page
parent
2e1a20b9
Branches
Branches containing commit
No related tags found
No related merge requests found
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
docs/source/guide_administrator.rst
+45
-1
45 additions, 1 deletion
docs/source/guide_administrator.rst
pedasi/settings.py
+1
-0
1 addition, 0 deletions
pedasi/settings.py
with
46 additions
and
1 deletion
docs/source/guide_administrator.rst
+
45
−
1
View file @
ec02c5cb
...
...
@@ -19,7 +19,10 @@ Overview
A deployment of PEDASI is done automatically to a remote Ubuntu server via a preconfigured Ansible script, which performs the following tasks:
1.
1. Install prerequisites
2. Configure databases
3. Install PEDASI
4. Configure and start webserver
Prerequisites
...
...
@@ -52,16 +55,57 @@ On your local machine, first clone the PEDASI repository:
Configuration
^^^^^^^^^^^^^
It it necessary to provide some configuration before deploying PEDASI.
1. Tell Ansible to which machine PEDASI should be deployed:
.. code-block:: none
:caption: inventory.yml
[default]
hostname.domain
2. Provide required configuration for Django - the required and optional settings are described in :mod:`pedasi.settings`.
The required settings are:
.. code-block:: none
:caption: deploy/.env
SECRET_KEY=<random string>
SOCIAL_AUTH_GOOGLE_OAUTH2_KEY=<Google OAuth2 key>
SOCIAL_AUTH_GOOGLE_OAUTH2_SECRET=<Google OAuth2 secret>
Deployment
^^^^^^^^^^
You may now deploy PEDASI using the Ansible provisioning script:
.. code-block:: console
$ ansible-playbook -v -i inventory.yml playbook.yml -u <your username on the remote host>
Post-Deployment
^^^^^^^^^^^^^^^
After deploying PEDASI you must create and activate an initial administrator account:
.. code-block:: console
$ sudo -s
$ cd /var/www/pedasi
$ source env/bin/activate
$ python manage.py createsuperuser --username <username> --email <email address>
Managing Data Sources
---------------------
In order for users to begin using PEDASI, you should provide access to a range of data sources.
The following sections will walk you through adding and managing your first data source.
We will use the IoTUK Nation Database API (see https://iotuk.org.uk/iotuk-nation-database-api/) as a basic example.
Adding a Data Source
^^^^^^^^^^^^^^^^^^^^
...
...
This diff is collapsed.
Click to expand it.
pedasi/settings.py
+
1
−
0
View file @
ec02c5cb
# TODO describe all required / optional settings
"""
Django settings for the PEDASI project.
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment