Skip to content

Commit

Permalink
move vagrant section to other (review needed)
Browse files Browse the repository at this point in the history
  • Loading branch information
landam committed Sep 10, 2017
1 parent e79cb0f commit 9e0da3e
Show file tree
Hide file tree
Showing 12 changed files with 1,214 additions and 100 deletions.
Binary file modified img/gisquick-published.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified img/gisquick-welcome.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1,118 changes: 1,118 additions & 0 deletions img/gisquick-welcome.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified img/installation/empty-project.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified img/installation/login-screen.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
44 changes: 22 additions & 22 deletions img/publish-directory.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions installation/docker.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Deployment in Docker containers
===============================
Deployment of server application in Docker containers
=====================================================

Gisquick application is split into 3 services running in Docker
containers:
Expand Down
21 changes: 10 additions & 11 deletions installation/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,29 +2,28 @@ Installation
############

Gisquick publishing platform consists of two major components:
**Django-based server application** and **QGIS client plugin**.

Server application can be deployed by Vagrant or Docker. In the first
subsection is described an easy and quick way of setting up
development environment by :doc:`deploying virtual server <vagrant>`
controlled by Vagrant. Following part is focused on :doc:`deployment
in Docker containers <docker>`, which is preferable for testing
purposes.
* Django-based **server application** and
* QGIS **client plugin**.

In the both cases, for deploying virtual server by Vagrant or Docker
containers, Gisquick source code is required. The source code can be
easily downloaded from GitHub repository using ``git`` command.
Server application can be easily deployed using *Docker*.

Deployment of server application requires Gisquick source code, which
can be easily downloaded from GitHub repository using ``git`` command.

.. _source-code:

.. code:: sh
$ git clone https://github.com/gislab-npo/gisquick.git
.. seealso:: |see| See also :doc:`deployment of virtual server by
Vagrant <vagrant>` section especially in the case of development
purposes.

.. toctree::
:maxdepth: 1

vagrant
docker
user-management
plugin
38 changes: 4 additions & 34 deletions installation/user-management.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,45 +4,15 @@ User management
Currently user accounts can be managed only manually from Django
shell.

At first, log in to Gisquick Django application server. The procedure
can vary when running virtual server by Vagrant or in Docker
containers.

Vagrant
-------

In the case of virtual server deployed using Vagrant, see
:doc:`vagrant`, log in by

.. code-block:: bash
$ vagrant ssh
Afterwards on the server enter Django shell

.. code-block:: bash
$ workon gisquick
$ python $HOME/deploy/www/manage.py shell
.. _vagrant-user:

.. tip:: Virtual server provided by Vagrant comes with predefined
``vagrant`` user account. This account can be used for testing
purposes. Password for this account is the same as the name,
ie. *vagrant*.

Docker
------

When running Gisquick in Docker containers, see :doc:`docker`, at
first Django app docker container must be identified. The following
command will also enter Django shell.
At first, log in to Gisquick Django application server. The following
command will identify Django container and enter Django shell.

.. code-block:: bash
$ docker exec -it `docker ps -qf "ancestor=gisquick/django"` django-admin shell
.. _create-account:

Create new user account
-----------------------

Expand Down
43 changes: 42 additions & 1 deletion installation/vagrant.rst
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ called from server prompt.
Afterwards Gisquick can be accessed on https://localhost:8000.
.. figure:: ../img/installation/vagrant-screen.png
.. figure:: ./img/installation/vagrant-screen.png
.. tip:: |tip| Use following command to run server tests from
``/vagrant/dev/django`` directory.
Expand Down Expand Up @@ -192,3 +192,44 @@ before starting :ref:`development services <vagrant-dev-services>`.
$ /vagrant/utils/tmux-dev.sh
$ cd /vagrant/clients
$ gulp build-web
User management
---------------
Log in to a virtual server by
.. code-block:: bash
$ vagrant ssh
Afterwards on the server enter Django shell
.. code-block:: bash
$ workon gisquick
$ python $HOME/deploy/www/manage.py shell
For creating a new user account, see :ref:`User management
<create-account>` section.
.. _vagrant-user:
.. tip:: Virtual server provided by Vagrant comes with predefined
``vagrant`` user account. This account can be used for testing
purposes. Password for this account is the same as the name,
ie. *vagrant*.
Transferring project to publication server
------------------------------------------
Publication directory :file:`dev/publish` is located in Gisquick
source code tree from which virtual machine has been provisioned, see
:ref:`directory layout <vagrant-dev-dir>`.
.. figure:: img/vagrant-directory.svg
:align: center
:width: 450
Publish directory for virtual server controlled by Vagrant.
6 changes: 6 additions & 0 deletions other.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,12 @@ Mobile
GIS.lab Mobile is represented by dedicated hybrid Android client interface
built on top of the same code base as web interface with native user interface.

-----------
Development
-----------

.. include:: installation/vagrant.rst

---------
Packaging
---------
Expand Down

0 comments on commit 9e0da3e

Please sign in to comment.