Skip to content

Latest commit

 

History

History
219 lines (175 loc) · 7.12 KB

INSTALL.md

File metadata and controls

219 lines (175 loc) · 7.12 KB

Installation

Development Environment

  • Clone git repo git clone https://github.com/qgis/QGIS-Plugins-Website.git

  • Run $ pwd in order to get your current directory

  • Path to your repo should be <your current directory>/QGIS-Plugins-Website

  • Go to dockerize directory cd QGIS-Plugins-Website/dockerize

  • Create .env file

$ cp .env.template .env

  • Edit .env file and set your environment variables

  • Enable debug mode by setting DEBUG=True.

  • Uncomment RABBITMQ_IMAGE if you want to use a different image version. Default is rabbitmq:3.7-alpine. This is useful if you encounter any issues with the default image (can be also use to change the image without editing the code). Please also see this discussion.

  • Build and spin container

$ make build
$ make devweb
  • Run migrate and seed db
$ make devweb-migrate
$ make dbseed

If you have a backup, you can restore it:

make dbrestore
  • Set up python interpreter in PyCharm or just runserver from devweb container:
$ make devweb-runserver

and now, you can see your site at http://localhost:62202 http://0.0.0.0:62202.

  • Run unit tests
$ make devweb-runtests
  • You can use the following credentials to log in if you ran the make dbseed command:
Admin account:
username: admin
password: admin

Staff account:
username: staff
password: staff

Plugin author account:
username: creator
password: creator
  • Update migrations:
$ make devweb-makemigrations app='plugins'
  • Run a django command from the devweb container
$ make devweb-exec c='python manage.py createsuperuser'
$ make devweb-exec c='pip freeze'
  • Enter the devweb container shell
$ make devweb-shell
  • If 'None' appears in the search results, it indicates a misalignment between the search index and the database. This discrepancy often arises when a plugin is deleted from the model but persists in the search index. To rectify this issue, it is essential to synchronize the search index with the database by rebuilding it. Execute the following command to initiate the rebuilding process:
$ make rebuild_index

This command ensures that the search index accurately reflects the current state of the database, resolving the presence of 'None' in the search results. Automatic synchronization is currently managed in settings.py: HAYSTACK_SIGNAL_PROCESSOR = "haystack.signals.RealtimeSignalProcessor".

For more information about make commands, please see the full docs here.

Production Environment

For the production environment, please see the the private repo of the System Administration Documentation.

Setup git-hooks and local linting

In the root directory of the repo, run:

pip install -r REQUIREMENTS-dev.txt

pre-commit install --config .pre-commit-config.yaml

Setting up a remote interpreter in PyCharm

  • PyCharm -> Preferences -> Project: QGIS-Plugins-Website
  • Click on the gear icon next to project interpreter -> add
  • SSH Interpreter -> New server configuration
  • Host : localhost
  • Port : 62203
  • Username: root
  • Click next button
  • Auth type: password (and tick 'save password')
  • Click next button
  • password : docker
  • Interpreter : /usr/local/bin/python
  • Sync folders -> click on the folder icon
    • local : <path to your repo>/dockerize/qgis-app
    • remote : /home/web/django_project After that you should see something like this in sync folder: <Project root>/django_project→/home/web/django_project
  • Automatically upload project files to the server -> untick the checkbox to avoid overwriting in your files.
  • Click the Apply button

In settings, django support:

  • Language & Framework -> Django
  • tick to Enable Django Support.
  • Django project root: <path to your repo>/qgis_app
  • Settings: setting_docker.py
  • Click the Apply button

Create the django run configuration

  • Run -> Edit configurations
  • Click the + icon in the top left corner
  • Choose Django server from the popup list

Now set these options:

  • Name: Django Server

  • Host: 0.0.0.0

  • Port: 8080

  • Additional options: --settings=settings.docker

  • Run browser If checked, it will open the url after you click run. You should be able to access the running on 0.0.0.0:62202 (the port that mapped to 8080)

  • Environment vars , you can add the variables value one-by-one by clicking on browse icon at right corner in the input field, or just copy-paste this value: PYTHONUNBUFFERED=1;DJANGO_SETTINGS_MODULE=settings_docker;RABBITMQ_HOST=rabbitmq;DATABASE_NAME=gis;DATABASE_USERNAME=docker;DATABASE_PASSWORD=docker;DATABASE_HOST=db

  • Python interpreter: Ensure it is set you your remote interpreter (should be set to that by default)

  • Path mappings: Here you need to indicate path equivalency between your host filesystem and the filesystem in the remote (docker) host. Click the ellipsis and add a run that points to your git checkout on your local host and the /home/web directory in the docker host. e.g.

    • Local path: /QGIS-Plugins-Website/qgis-app
    • Remote path: /home/web/django_project

  • click OK to save your run configuration

Now you can run the server using the green triangle next to the Django server label in the run configurations pull down. Debug will also work and you will be able to step through views etc as you work.

Backup and Restore

  • Go to repo directory and run backup.sh
$ ./backup.sh
  • You will find dumps file in backups directory
$ tree -L 3 backups
backups
├── 2016
├── 2017
├── 2018
├── 2019
├── 2020
│   ├── April
│   │   └── PG_QGIS_PLUGINS_gis.07-April-2020.dmp
│   ├── August
│   ├── December
│   │   ├── PG_QGIS_PLUGINS_gis.01-December-2020.dmp
│   │   ├── PG_QGIS_PLUGINS_gis.02-December-2020.dmp
│   │   ├── PG_QGIS_PLUGINS_gis.03-December-2020.dmp
│   │   ├── PG_QGIS_PLUGINS_gis.04-December-2020.dmp
│   │   ├── PG_QGIS_PLUGINS_gis.05-December-2020.dmp
│   │   ├── PG_QGIS_PLUGINS_gis.06-December-2020.dmp
│   │   ├── PG_QGIS_PLUGINS_gis.07-December-2020.dmp
│   │   ├── PG_QGIS_PLUGINS_gis.08-December-2020.dmp
│   │   ├── PG_QGIS_PLUGINS_gis.09-December-2020.dmp
│   │   ├── PG_QGIS_PLUGINS_gis.10-December-2020.dmp
│   │   ├── PG_QGIS_PLUGINS_gis.11-December-2020.dmp
│   │   ├── PG_QGIS_PLUGINS_gis.12-December-2020.dmp
│   │   ├── PG_QGIS_PLUGINS_gis.13-December-2020.dmp
│   │   ├── PG_QGIS_PLUGINS_gis.14-December-2020.dmp
│   │   ├── PG_QGIS_PLUGINS_gis.15-December-2020.dmp
│   │   └── PG_QGIS_PLUGINS_gis.16-December-2020.dmp
│`
  • Copy the dump file you wish to restore to dockerize/backups/latest.dmp file
$ cp backups/2020/December/PG_QGIS_PLUGINS_gis.16-December-2020.dmp dockerize/backups/latest.dmp
  • Restore the dump file
$ cd dockerize
$ make dbrestore