Skip to content

Commit

Permalink
Add more branding settings to the deployment documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
markkuriekkinen committed Feb 5, 2021
1 parent b89d488 commit 856a2fd
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 3 deletions.
22 changes: 20 additions & 2 deletions aplus/local_settings.example.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#DEBUG = True
#DEBUG = False
#SECRET_KEY = '' # will be autogenerated in secret_key.py if not specified here
#BASE_URL = 'http://localhost:8000/' # required!
#SERVER_EMAIL = '[email protected]'
Expand All @@ -7,8 +7,26 @@
#)
## Branding
#BRAND_NAME = 'Your brand name (default is A+)'
#BRAND_NAME_LONG = 'Aplus'
#BRAND_DESCRIPTION = 'Description of your service (default is Virtual Learning Environment)'
# BRAND_INSTITUTION_NAME = Your institution name, e.g., 'Aalto University', 'Tampere university'
#BRAND_INSTITUTION_NAME = Your institution name, e.g., 'Aalto University', 'Tampere university'
#BRAND_INSTITUTION_NAME_FI = 'Aalto-yliopisto'
#WELCOME_TEXT = 'Welcome to A+ <small>modern learning environment</small>'
#SHIBBOLETH_TITLE_TEXT = 'Aalto University users'
#SHIBBOLETH_BODY_TEXT = 'Log in with your Aalto University user account by clicking on the button below. FiTech, Open University and programme students as well as staff members must log in here.'
#SHIBBOLETH_BUTTON_TEXT = 'Log in with Aalto account'
#MOOC_TITLE_TEXT = 'Users external to Aalto'
#MOOC_BODY_TEXT = 'Some of our courses are open for everyone. Log in with your user account from one of the following services.'
#INTERNAL_USER_LABEL = 'Aalto'
#EXTERNAL_USER_LABEL = 'MOOC'

#WELCOME_TEXT_FI = 'A+ <small>verkkopohjainen oppimisympäristö</small>'
#SHIBBOLETH_TITLE_TEXT_FI = 'Aalto-yliopiston käyttäjät'
#SHIBBOLETH_BODY_TEXT_FI = 'Kirjaudu palveluun Aalto-yliopiston käyttäjätunnuksella alla olevasta painikkeesta. FiTechin, avoimen yliopiston ja koulutusohjelmien opiskelijoiden sekä henkilökunnan täytyy kirjautua tästä.'
#SHIBBOLETH_BUTTON_TEXT_FI = 'Kirjaudu Aalto-tunnuksella'
#MOOC_TITLE_TEXT_FI = 'Käyttäjät Aallon ulkopuolelta'
#MOOC_BODY_TEXT_FI = 'Osa kursseistamme on avoinna kaikille. Kirjaudu sisään jonkin seuraavan palvelun käyttäjätunnuksellasi.'

# Show red alert on top of all pages
#SITEWIDE_ALERT_TEXT = "Maintenance on Monday"
#SITEWIDE_ALERT_TEXT = {'en': "Maintenance on Monday", 'fi': "Maanantaina on palvelukatko"}
Expand Down
8 changes: 7 additions & 1 deletion doc/DEPLOYMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ The Application
1. Clone the Django application

# as user aplus in /srv/aplus
git clone --branch production https://github.com/Aalto-LeTech/a-plus.git
git clone --branch production https://github.com/apluslms/a-plus.git
mkdir a-plus/static \
a-plus/media

Expand Down Expand Up @@ -116,6 +116,12 @@ The Application
}
EOF

Define the branding settings in `aplus/local_settings.py`:
`BRAND_NAME`, `BRAND_INSTITUTION_NAME`, `BRAND_INSTITUTION_NAME_FI`, etc.
Check `settings.py` and `local_settings.example.py`.

Ensure that you use `DEBUG = False` in production (`local_setting.py`).

1. Run Django deployment tasks

# as user aplus in /srv/aplus
Expand Down

0 comments on commit 856a2fd

Please sign in to comment.