Skip to content

Commit 4a764f6

Browse files
committed
Update README according to the latest updates
1 parent 90533d8 commit 4a764f6

File tree

3 files changed

+14
-84
lines changed

3 files changed

+14
-84
lines changed

README.md

+14-84
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,15 @@
44

55
This application is the backend part that manages and serves news for the QGIS welcome page.
66

7+
![img](./img/homepage.png)
8+
9+
## Tech stack
10+
11+
![image](./img/Docker_Services.png)
12+
13+
This application is based on Django, written in Python and deployed on the server using
14+
docker-compose.
15+
716
## Installation Guide
817
<details>
918
<summary><strong>Development Environment Installation</strong></summary>
@@ -338,92 +347,13 @@ Now check if your browser is showing the site opening with no SSL errors: https:
338347

339348
</details>
340349

341-
<details>
342-
<summary><strong>Backups</strong></summary>
343-
</br>
344-
345-
If something goes terribly wrong, we keep 7 nights of backups on hetzner
346-
347-
If those are also not useful there are a collection of snapshot backups on hetzner
348-
349-
Last resort: Tim makes backups to his local machine on a semi-regular basis.
350-
351-
</details>
352-
353-
<details>
354-
<summary><strong>Deploying on Rancher</strong></summary>
355-
</br>
356-
357-
This repository contains a rancher template directory (the ``template`` folder in the root of the repo)
358-
which can be used to deploy this site onto a host using [Rancher](https://rancher.com). Currently ony Rancher v1.6
359-
(i.e. not v2) is supported.
360-
361-
This guide serves as a quick setup guide to spin up a one of our Rancher catalogue packages.
350+
Please visit the private Sysadmin documentation for more details about the deployment of https://feed.qgis.org
362351

363-
</details>
364352

353+
## Backups
365354

366-
<details>
367-
<summary><strong>Prerequisites</strong></summary>
368-
</br>
355+
If something goes terribly wrong, we keep 7 nights of backups on hetzner and daily backups on a storage box.
369356

370-
This guide assumes that the following steps have been done:
357+
If those are also not useful there are a collection of snapshot backups on hetzner and on a storage box
371358

372-
1. **Install Docker:** Docker is installed on your server. Use Ubuntu 16.04 for the best results
373-
because that is what we are testing on. For quick installation, use the
374-
[convenience scripts](http://rancher.com/docs/rancher/v1.6/en/hosts/#supported-docker-versions)
375-
provided by Rancher (make sure you choose a supported version).
376-
377-
378-
2. **Install Rancher:** The **stable** version of Rancher v1 Server has been set up.
379-
380-
If it's not, refer to [Rancher quickstart
381-
guide](http://rancher.com/docs/rancher/v1.6/en/installing-rancher/installing-server/).
382-
Here is an example of how to run the latest stable release with a persistent
383-
mysql database stored on the file system:
384-
385-
```
386-
mkdir /home/mysql
387-
docker run -d -v /home/mysql:/var/lib/mysql --restart=unless-stopped -p 8080:8080 rancher/server:stable
388-
```
389-
390-
3. **Create an environment:** Once rancher server has been set up. Create an
391-
environment. You can create an Rancher environment ``<rancher
392-
url>/settings/env/add``.
393-
394-
4. **Set up the Hetzner Machine Driver**: This only applies if you are using
395-
Hetzner Cloud as your hosting provider. You can automatically manage and deploy
396-
hosts on Hetzner using the Admin -> Machine Drivers menu and then enable the
397-
Hetzner driver.
398-
399-
5. **Add a host:** You need to add a host to the environment has been set up to
400-
actually run the instance (the agent could be on the same host as the rancher
401-
server but it is not recommended). You can do this by ensuring your chosen
402-
environment is active and then from the menu do ``Environment -> Hosts``. If you
403-
running on hetzner cloud, choose the Hetzner machine driver and then enter the
404-
API key for your Hetzner Cloud project (you can get this key from the Hetzner
405-
Cloud admin ui). Alternatively manually set up a linux host with docker on it
406-
and then use the manual host setup as directed by the ``Infrastructure -> Hosts
407-
-> Add Host`` page in Rancher. The process is quite logical and simple and
408-
involves pasting a single line of code onto the host that will run the agent.
409-
Once the host is set up with a running agent, you should see it join the
410-
environment as shown below:
411-
412-
413-
![screen shot 2017-11-02 at 19 03 32](https://user-images.githubusercontent.com/178003/32339631-0bbb10f6-c001-11e7-9218-37074d7feafc.png)
414-
415-
416-
6. ** Installing from the catalogue:** Once Rancher is installed, your
417-
environment and host are set up, use the Admin -> Settings menu to add our
418-
Rancher catalogue using this URL:
419-
420-
https://github.com/qgis/qgis-feed
421-
422-
Once your settings are saved open a Rancher environment and set up a
423-
stack from the catalogue's 'QGIS' section - you will see
424-
QGIS-Feed listed there.
425-
426-
427-
Now you can add items from the QGIS catalogue to your stack.
428-
429-
</details>
359+
Last resort: Tim makes backups to his local machine on a semi-regular basis.

img/Docker_Services.png

30.7 KB
Loading

img/homepage.png

761 KB
Loading

0 commit comments

Comments
 (0)