diff --git a/docs/admins_docs.md b/docs/admins_docs.md index 6a61ed3..e4a10f7 100644 --- a/docs/admins_docs.md +++ b/docs/admins_docs.md @@ -17,17 +17,18 @@ - [14. Add Google Analytics](#14-add-google-analytics) - [15. Debugging email issues](#15-debugging-email-issues) - [16. Frequently Asked Questions](#16-frequently-asked-questions) +- [17. Cookie consent code](#17-cookie-consent-code) ## 1. Welcome -This page is created for MediaCMS administrators that are responsible for setting up the software, maintaining it and making modifications. +This page is created for MediaCMS administrators that are responsible for setting up the software, maintaining it and making modifications. ## 2. Server Installation The core dependencies are Python3, Django3, Celery, PostgreSQL, Redis, ffmpeg. Any system that can have these dependencies installed, can run MediaCMS. But we strongly suggest installing on Linux Ubuntu 18 or 20 versions. Installation on a Ubuntu 18 or 20 system with git utility installed should be completed in a few minutes with the following steps. -Make sure you run it as user root, on a clear system, since the automatic script will install and configure the following services: Celery/PostgreSQL/Redis/Nginx and will override any existing settings. +Make sure you run it as user root, on a clear system, since the automatic script will install and configure the following services: Celery/PostgreSQL/Redis/Nginx and will override any existing settings. Automated script - tested on Ubuntu 18, Ubuntu 20, and Debian Buster @@ -37,7 +38,7 @@ git clone https://github.com/mediacms-io/mediacms cd /home/mediacms.io/mediacms/ && bash ./install.sh ``` -The script will ask if you have a URL where you want to deploy MediaCMS, otherwise it will use localhost. If you provide a URL, it will use Let's Encrypt service to install a valid ssl certificate. +The script will ask if you have a URL where you want to deploy MediaCMS, otherwise it will use localhost. If you provide a URL, it will use Let's Encrypt service to install a valid ssl certificate. ### Update @@ -145,9 +146,9 @@ The main container runs migrations, mediacms_web, celery_beat, celery_workers (c The FRONTEND_HOST in `deploy/docker/local_settings.py` is configured as http://localhost, on the docker host machine. ### Server with ssl certificate through letsencrypt service, accessed as https://my_domain.com -Before trying this out make sure the ip points to my_domain.com. +Before trying this out make sure the ip points to my_domain.com. -With this method [this deployment](../docker-compose-letsencrypt.yaml) is used. +With this method [this deployment](../docker-compose-letsencrypt.yaml) is used. Edit this file and set `VIRTUAL_HOST` as my_domain.com, `LETSENCRYPT_HOST` as my_domain.com, and your email on `LETSENCRYPT_EMAIL` @@ -177,15 +178,15 @@ The architecture below generalises all the deployment scenarios above, and provi ## 5. Configuration Several options are available on `cms/settings.py`, most of the things that are allowed or should be disallowed are described there. -It is advisable to override any of them by adding it to `local_settings.py` . +It is advisable to override any of them by adding it to `local_settings.py` . In case of a the single server installation, add to `cms/local_settings.py` . In case of a docker compose installation, add to `deploy/docker/local_settings.py` . This will automatically overwrite `cms/local_settings.py` . -Any change needs restart of MediaCMS in order to take effect. +Any change needs restart of MediaCMS in order to take effect. -Single server installation: edit `cms/local_settings.py`, make a change and restart MediaCMS +Single server installation: edit `cms/local_settings.py`, make a change and restart MediaCMS ```bash #systemctl restart mediacms @@ -213,7 +214,7 @@ PORTAL_NAME = 'my awesome portal' By default `CAN_ADD_MEDIA = "all"` means that all registered users can add media. Other valid options are: -- **email_verified**, a user not only has to register an account but also verify the email (by clicking the link sent upon registration). Apparently email configuration need to work, otherise users won't receive emails. +- **email_verified**, a user not only has to register an account but also verify the email (by clicking the link sent upon registration). Apparently email configuration need to work, otherise users won't receive emails. - **advancedUser**, only users that are marked as advanced users can add media. Admins or MediaCMS managers can make users advanced users by editing their profile and selecting advancedUser. @@ -282,7 +283,7 @@ Make changes (True/False) to any of the following: ### 5.9 Show or hide the download option on a media -Edit `templates/config/installation/features.html` and set +Edit `templates/config/installation/features.html` and set ``` download: false @@ -291,7 +292,7 @@ download: false ### 5.10 Automatically hide media upon being reported set a low number for variable `REPORTED_TIMES_THRESHOLD` -eg +eg ``` REPORTED_TIMES_THRESHOLD = 2 @@ -339,7 +340,7 @@ set value MEDIA_IS_REVIEWED = False ``` -any uploaded media now needs to be reviewed before it can appear to the listings. +any uploaded media now needs to be reviewed before it can appear to the listings. MediaCMS editors/managers/admins can visit the media page and edit it, where they can see the option to mark media as reviewed. By default this is set to True, so all media don't require to be reviewed ### 5.15 Specify maximum number of media for a playlist @@ -354,7 +355,7 @@ MAX_MEDIA_PER_PLAYLIST = 14 ### 5.16 Specify maximum size of a media that can be uploaded -change `UPLOAD_MAX_SIZE`. +change `UPLOAD_MAX_SIZE`. default is 4GB @@ -417,7 +418,7 @@ Global notifications that are implemented are controlled by the following option ``` USERS_NOTIFICATIONS = { - 'MEDIA_ADDED': True, + 'MEDIA_ADDED': True, } ``` @@ -466,13 +467,13 @@ For example, the `Active` state of any profile can be toggled to enable or disab ## 13. How To Add A Static Page To The Sidebar -### 1. Create your html page in templates/cms/ +### 1. Create your html page in templates/cms/ e.g. duplicate and rename about.html ``` sudo cp templates/cms/about.html templates/cms/volunteer.html ``` -### 2. Create your css file in static/css/ +### 2. Create your css file in static/css/ ``` touch static/css/volunteer.css ``` @@ -536,24 +537,24 @@ urlpatterns = [ ### 8. Add your page to the left sidebar To add a link to your page as a menu item in the left sidebar, -add the following code after the last line in _commons.js +add the following code after the last line in _commons.js ``` /* Checks that a given selector has loaded. */ const checkElement = async selector => { while ( document.querySelector(selector) === null) { await new Promise( resolve => requestAnimationFrame(resolve) ) } - return document.querySelector(selector); + return document.querySelector(selector); }; /* Checks that sidebar nav menu has loaded, then adds menu item. */ checkElement('.nav-menu') .then((element) => { - (function(){ - var a = document.createElement('a'); + (function(){ + var a = document.createElement('a'); a.href = "/volunteer"; a.title = "Volunteer"; - + var s = document.createElement('span'); s.className = "menu-item-icon"; @@ -563,7 +564,7 @@ checkElement('.nav-menu') s.appendChild(icon); a.appendChild(s); - + var linkText = document.createTextNode("Volunteer"); var t = document.createElement('span'); @@ -575,14 +576,14 @@ checkElement('.nav-menu') listItem.appendChild(a); //if signed out use 3rd nav-menu - var elem = document.querySelector(".nav-menu:nth-child(3) nav ul"); + var elem = document.querySelector(".nav-menu:nth-child(3) nav ul"); var loc = elem.innerText; if (loc.includes("About")){ elem.insertBefore(listItem, elem.children[2]); } else { //if signed in use 4th nav-menu elem = document.querySelector(".nav-menu:nth-child(4) nav ul"); elem.insertBefore(listItem, elem.children[2]); - } + } })(); }); ``` @@ -608,7 +609,7 @@ Instructions contributed by @alberto98fx 2. Add the Gtag/Analytics script -3. Inside ``` $DIR/mediacms/templates/root.html``` you'll see a file like this one: +3. Inside ``` $DIR/mediacms/templates/root.html``` you'll see a file like this one: ``` @@ -619,7 +620,7 @@ Instructions contributed by @alberto98fx {% include "common/head-meta.html" %} {% block headermeta %} - + @@ -632,17 +633,17 @@ Instructions contributed by @alberto98fx {% block topimports %}{%endblock topimports %} {% include "config/index.html" %} - + {% endblock head %} ``` 4. Add ``` {% include "tracking.html" %} ``` at the end inside the section `````` - -5. If you are using Docker and didn't mount the entire dir you need to bind a new volume: + +5. If you are using Docker and didn't mount the entire dir you need to bind a new volume: ``` - + web: image: mediacms/mediacms:latest restart: unless-stopped @@ -653,7 +654,7 @@ Instructions contributed by @alberto98fx volumes: - ./templates/root.html:/home/mediacms.io/mediacms/templates/root.html - ./templates/tracking.html://home/mediacms.io/mediacms/templates/tracking.html - + ``` ## 15. Debugging email issues @@ -684,7 +685,7 @@ email = EmailMessage( email.send(fail_silently=False) ``` -You have the chance to either receive the email (in this case it will be sent to recipient@email.com) otherwise you will see the error. +You have the chance to either receive the email (in this case it will be sent to recipient@email.com) otherwise you will see the error. For example, while specifying wrong password for my Gmail account I get ``` @@ -694,7 +695,7 @@ SMTPAuthenticationError: (535, b'5.7.8 Username and Password not accepted. Learn ## 16. Frequently Asked Questions Video is playing but preview thumbnails are not showing for large video files -Chances are that the sprites file was not created correctly. +Chances are that the sprites file was not created correctly. The output of files.tasks.produce_sprite_from_video() function in this case is something like this ``` @@ -708,16 +709,16 @@ Solution: edit file `/etc/ImageMagick-6/policy.xml` and set bigger values for th ``` -Newly added video files now will be able to produce the sprites file needed for thumbnail previews. To re-run that task on existing videos, enter the Django shell +Newly added video files now will be able to produce the sprites file needed for thumbnail previews. To re-run that task on existing videos, enter the Django shell ``` -root@8433f923ccf5:/home/mediacms.io/mediacms# source /home/mediacms.io/bin/activate +root@8433f923ccf5:/home/mediacms.io/mediacms# source /home/mediacms.io/bin/activate root@8433f923ccf5:/home/mediacms.io/mediacms# python manage.py shell -Python 3.8.14 (default, Sep 13 2022, 02:23:58) +Python 3.8.14 (default, Sep 13 2022, 02:23:58) ``` -and run +and run ``` In [1]: from files.models import Media @@ -727,4 +728,10 @@ In [3]: for media in Media.objects.filter(media_type='video', sprites=''): ...: produce_sprite_from_video(media.friendly_token) ``` -this will re-create the sprites for videos that the task failed. +this will re-create the sprites for videos that the task failed. + + +## 17. Cookie consent code +On file `templates/components/header.html` you can find a simple cookie consent code. It is commented, so you have to remove the `{% comment %}` and `{% endcomment %}` lines in order to enable it. Or you can replace that part with your own code that handles cookie consent banners. + +![Simple Cookie Consent](images/cookie_consent.png) \ No newline at end of file diff --git a/docs/images/cookie_consent.png b/docs/images/cookie_consent.png new file mode 100644 index 0000000..24335f1 Binary files /dev/null and b/docs/images/cookie_consent.png differ diff --git a/templates/components/header.html b/templates/components/header.html index 1a1eb05..716e328 100644 --- a/templates/components/header.html +++ b/templates/components/header.html @@ -1 +1,20 @@ -
\ No newline at end of file +
+ +{% comment %} +Uncomment, or replace with your own cookie consent code. + + + + + +{% endcomment %} \ No newline at end of file