You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+21-3Lines changed: 21 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,13 +8,15 @@ The sources are [on Github](https://github.com/mapbender/mapbender-documentation
8
8
9
9
The website code is generated using [Sphinx](http://sphinx-doc.org/), therefore the documentation source is written in [Restructured Text](http://sphinx-doc.org/rest.html).
10
10
11
-
You find a documentation about how the documentation is structured in the documentation itself in chapter [How to write Mapbender Documentation?](http://doc.mapbender.org/en/book/development/documentation_howto.html) or directly [here in this Git-Repository](https://github.com/mapbender/mapbender-documentation/blob/master/en/book/development/documentation_howto.rst).
11
+
You find a documentation about how the documentation is structured in the documentation itself in chapter [How to write Mapbender Documentation?](http://doc.mapbender.org/en/book/development/documentation_howto.html) or directly [here in this Git-Repository](https://github.com/mapbender/mapbender-documentation/blob/master/en/documentation_howto.rst).
12
12
13
13
14
14
To build the website locally, you need to install Sphinx. Install it in Debian-based distributions via
15
15
16
16
```bash
17
-
$ apt install python-sphinx
17
+
sudo apt-get install sphinx-common python3-sphinx
18
+
sudo apt-get install pip3
19
+
sudo pip3 install sphinxcontrib-phpdomain
18
20
```
19
21
20
22
You can then build the documentation by running:
@@ -23,7 +25,23 @@ You can then build the documentation by running:
Installation von Mapbender unter Verwendung des Symfony-eigenen Webservers
4
4
#################################
5
5
6
-
Mapbender baut auf dem `Symfony <http://symfony.com/>`_ Framework auf und kann daher den in `Symfony eingebauten Webserver <http://symfony.com/doc/current/cookbook/web_server/built_in.html>`_ nutzen. Das ermöglicht Ihnen einen schnellen Test von Mapbender, ohne eine Integration in einen Webserver vorzunehmen. Dies eignet sich nicht für Produktivumgebungen. In dieser Anleitung wird die SQLite Datenbank verwendet.
6
+
Mapbender baut auf das `Symfony <http://symfony.com/>`_ Framework auf und kann
7
+
daher den `Symfony-eigenen Webserver <http://symfony.com/doc/current/cookbook/web_server/built_in.html>`_ nutzen.
8
+
Das ermöglicht Ihnen einen schnellen Test von Mapbender, ohne eine Integration in einen Webserver vorzunehmen.
7
9
8
-
* Systemvoraussetzungen in der Installationsanleitung `Linux <installation_ubuntu.html>`_ bzw. `Windows <installation_windows.html>`_
9
-
* Download der aktuellen Mapbender Version unter https://mapbender.org/builds/
10
+
.. hint:: Der Symfony-eigenen Webserver eignet sich nicht für die Produktivumgebungen.
11
+
12
+
In dieser Anleitung wird die im Installationspaket mitgelieferte SQLite-Datenbank verwendet.
13
+
14
+
* Bitte prüfen Sie die Systemvoraussetzungen in der Installationsanleitung `Linux <installation_ubuntu.html>`_ bzw. `Windows <installation_windows.html>`_
15
+
* Laden Sie die aktuellen Mapbender-Version herunter https://mapbender.org/builds/
10
16
* Entpacken in ein beliebiges Verzeichnis.
11
-
* Start des Symfony Webserver:
17
+
* Starten Sie den Symfony-eigenen Webserver.
18
+
19
+
.. code-block:: bash
20
+
21
+
app/console server:run
22
+
23
+
Der Befehl führt einen lokalen Webserver aus.
24
+
25
+
Standardmäßig lauscht der Server auf die Adresse 127.0.0.1 und den ersten freien Port ab 8000.
26
+
27
+
Mapbender ist nun auf dem lokalen Rechner über die Adresse http://127.0.0.1:8001/ erreichbar.
28
+
Beachten Sie, dass über diesen Aufruf standardmäßig der Entwickler-Modus gestartet wird.
29
+
30
+
Sie können den Aufruf auch mehrfach ausführen. Es wird dann der nächste freie Port verwendet.
31
+
32
+
Die gewünschte Adresse kann auch über die Angabe der IP und des Ports angegeben werden:
12
33
13
-
.. code-block:: bash
34
+
.. code-block:: bash
14
35
15
-
app/console server:run 0.0.0.0:8000
36
+
app/console server:run 127.0.0.1:80002
37
+
38
+
[OK] Server listening on http://127.0.0.1:8002
39
+
40
+
// Quit the server with CONTROL-C.
16
41
17
-
Mapbender ist dann vom Host-Rechner aus über http://ip-adresse:8000/app.php erreichbar.
42
+
[Mon Jan 31 15:56:57 2022] PHP 7.4.3 Development Server (http://127.0.0.1:8002) started
Copy file name to clipboardExpand all lines: de/installation/installation_ubuntu.rst
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,14 +6,14 @@ Installation auf Ubuntu/Debian
6
6
Die mitgelieferte SQLite Datenbank ist für Testinstallationen geeignet. In dieser Datenbank befinden sich bereits vorkonfigurierte Demoanwendungen (die Datenbank liegt unter **<mapbender>/app/db/demo.sqlite**).
7
7
Eine Anleitung für eine Testinstallation auf Basis des Symfony Webservers finden Sie unter `Installation auf dem Symfony eigenen Webserver <installation_symfony.html>`_.
8
8
9
-
Für den Produktiveinsatz wird PostgreSQL empfohlen.
9
+
.. hint:: Für den Produktiveinsatz wird PostgreSQL empfohlen.
10
10
Weitere Installationshinweise finden Sie im Kapitel `Optional > Mapbender Einrichtung auf PostgreSQL <#optional>`_.
11
11
12
12
13
13
Voraussetzungen
14
14
---------------
15
15
16
-
- PHP (ab Version 5.6, maximal 7.2)
16
+
- PHP >= 7.1
17
17
- Apache Installation mit folgenden aktivierten Modulen:
18
18
19
19
* mod_rewrite
@@ -36,7 +36,7 @@ Installation der benötigten PHP-Extensions:
36
36
Entpacken und im Webserver registrieren
37
37
---------------------------------------
38
38
39
-
Download der aktuellen Mapbender Version und entpacken nach /var/www/mapbender:
39
+
Download der aktuellen Mapbender Version und entpacken nach /var/www/mapbender oder ein anderes Verzeichnis:
40
40
41
41
.. code-block:: bash
42
42
@@ -90,7 +90,7 @@ Verzeichnisrechte
90
90
91
91
Nächste Schritte
92
92
----------------
93
-
Es kann nun auf die Mapbender Installation unter **http://hostname/mapbender/** zugegriffen werden.
93
+
Es kann nun auf die Mapbender Installation unter **http://[hostname]/mapbender/** zugegriffen werden.
Copy file name to clipboardExpand all lines: de/installation/installation_update.rst
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,13 +7,12 @@ Um Mapbender zu aktualisieren, müssen Sie die folgenden Schritte durchführen:
7
7
8
8
* Laden Sie die neuste Version von http://mapbender.org/builds/ herunter
9
9
* Sichern Sie Ihre Konfigurationsdateien (parameters.yml und config.yml) und Ihre alte Mapbender Version (Dateien und Datenbank)
10
-
* Ersetzen Sie die Dateien durch die neuen MapbenderDateien
10
+
* Ersetzen Sie die Dateien durch die neuen Mapbender-Dateien
11
11
* Vergleichen Sie die Konfigurationsdateien und prüfen diese auf neue Parameter und Änderungen
12
-
* Aktualisieren Sie Ihre MapbenderDatenbank
13
-
* Übernahme Ihrer Screenshots: Kopieren Sie die Dateien Ihrer alten Mapbender Version von /web/uploads/ in das /web/uploads Verzeichnis Ihrer neuen Mapbender Version
12
+
* Aktualisieren Sie Ihre Mapbender-Datenbank
13
+
* Übernahme Ihrer Screenshots: Kopieren Sie die Dateien Ihrer alten Mapbender Version von mapbender/web/uploads/ in das mapbender/web/uploads Verzeichnis Ihrer neuen Mapbender Version
14
14
* Wenn Sie Ihre eigenen Templates verwenden sollten, müssen Sie diese mit denen der neuen Version vergleichen (kam es zu Änderungen?)
15
-
* Importieren Sie die Anwendungen aus der mapbender.yml Datei, um sich den neusten Stand der Entwicklungen anzuschauen
16
-
* Abhängig von Ihrer alten Mapbender Version, muss unter Umständen noch der Apache Alias für Mapbender in der Datei **/etc/apache2/sites-available/mapbender.conf** angepasst werden
15
+
* Importieren Sie die Demo-Anwendungen (über den Befehl bin/composer run reimport-example-apps oder über die Web-Administration), um sich den neusten Stand der Entwicklungen anzuschauen
17
16
* Unter https://doc.mapbender.org/de/installation/installation_ubuntu.html im Bereich **Entpacken und im Webserver registrieren** ist beschrieben, wie die Konfigurationsdatei für den Apache Alias aussehen sollte
18
17
* Das war's auch schon! Schauen Sie sich Ihre neue Mapbender Version an.
19
18
@@ -54,9 +53,10 @@ Im Folgenden sind die einzelnen Schritte als Befehle aufgeführt.
54
53
app/console doctrine:schema:update --dump-sql
55
54
app/console doctrine:schema:update --force
56
55
57
-
# Importieren Sie die Anwendungen aus der mapbender.yml Datei, um sich den neusten Stand der Entwicklungen anzuschauen
56
+
# Importieren Sie die Demo-Anwendungen, um sich den neusten Stand der Entwicklungen anzuschauen
58
57
bin/composer run reimport-example-apps
59
58
59
+
# export the web directory
60
60
app/console assets:install web --symlink --relative
61
61
62
62
# Setzen Sie die Schreibrechte für Besitzer (u), Gruppe (g) und Andere (a). Weisen Sie die Skripte dem Apache User (www-data) zu.
Copy file name to clipboardExpand all lines: en/documentation_howto.rst
+22-27Lines changed: 22 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ You find the Mapbender Documentation at:
10
10
11
11
https://doc.mapbender.org
12
12
13
-
The Documentation is build from the mapbender-docmentation repository at Github. This repository is used to build and deploy the http://doc.mapbender.org website on a nightly base. The website code is generated using Sphinx, therefore the documentation source is written in Restructured Text.
13
+
The Documentation is build from the mapbender-docmentation repository at Github. This repository is used to build and deploy the https://doc.mapbender.org website. The website code is generated using Sphinx, therefore the documentation source is written in Restructured Text.
14
14
15
15
This HowTo concentrates on the build of the documentation at http://doc.mapbender.org.
16
16
@@ -47,25 +47,13 @@ Every language (en - english, de - german) has the same file structure.
47
47
index.rst # refers to TheBook, Developer's Book & the Bundle Documentation
48
48
bundles.rst # lists the chapters of this category - refers to rst files
49
49
development.rst # lists the chapters of this category - refers to rst files
50
-
thebook.rst # lists the chapters of this category - refers to rst files
51
-
/book
52
-
....
53
-
/development
50
+
/architecture
51
+
/development
52
+
....
53
+
/functions
54
+
/backend
55
+
/basic
54
56
....
55
-
/bundles
56
-
/Mapbender
57
-
/CoreBundle
58
-
index.rst # refers to the elements, entitiy & service documentation
59
-
template_element.rst # template to use for new element documentation
60
-
/elements
61
-
legend.rst
62
-
...
63
-
/services
64
-
...
65
-
/WmsBundle
66
-
...
67
-
/FOM
68
-
...
69
57
70
58
71
59
How to build the documentation via Sphinx?
@@ -77,14 +65,17 @@ To build the website locally, you need to install Sphinx. In Debian-based distri
77
65
78
66
.. code-block:: bash
79
67
80
-
apt-get install python-sphinx
68
+
sudo apt-get install sphinx-common python3-sphinx
69
+
sudo apt-get install pip3
70
+
sudo pip3 install sphinxcontrib-phpdomain
81
71
82
72
83
73
You can then build the documentation by running
84
74
85
75
.. code-block:: bash
86
76
87
-
sphinx-build . output
77
+
sphinx-build . _build -A version=3.2.0
78
+
88
79
89
80
You can also use the generate.sh shell script if you like.
90
81
@@ -157,7 +148,7 @@ Here are the steps you have to do:
Installation of Mapbender using Symfony built-in webserver
4
4
##############################################
5
5
6
-
Mapbender is built on the `Symfony <http://symfony.com/>`_ Framework and therefore can take usage of the `Symfony built-in webserver <http://symfony.com/doc/current/cookbook/web_server/built_in.html>`_. This allows a quick test of Mapbender without an integration into an external webserver. This is not suited for production environments. In this document we assume that the SQLite database is used.
6
+
Mapbender is built on the `Symfony <http://symfony.com/>`_ Framework and therefore
7
+
can make use of the `Symfony built-in webserver <http://symfony.com/doc/current/cookbook/web_server/built_in.html>`_.
8
+
This setup allows a quick test of Mapbender without an integration into an external webserver.
7
9
8
-
* Take notice of the installation documentation `Linux <installation_ubuntu.html>`_ respectively `Windows <installation_windows.html>`_
10
+
.. hint:: The use of the Symfony built-in webserver is not suitable for production environments.
11
+
12
+
In this document we assume that the SQLite database is used.
13
+
14
+
* Please check the installation documentation for `Linux <installation_ubuntu.html>`_ respectively `Windows <installation_windows.html>`_
9
15
* Download the current Mapbender version https://mapbender.org/builds/.
10
16
* Extract Mapbender in an arbitrary directory.
11
-
* Start the Symfony webserver:
17
+
* Start the Symfony webserver.
18
+
19
+
.. code-block:: bash
20
+
21
+
app/console server:run
22
+
23
+
The command runs a local web server. By default, the server listens on 127.0.0.1 address
24
+
and the port number is automatically selected as the first free port starting from 8000.
25
+
26
+
Now Mapbender is available on the local machine with the address http://127.0.0.1:8001/.
27
+
Please note that Mapbender runs in the developer mode per default.
28
+
29
+
30
+
31
+
If you run the command several times Symfony will choose the next available port.
32
+
33
+
34
+
You also could change the default address and port by passing them as an argument:
12
35
13
-
.. code-block:: bash
36
+
.. code-block:: bash
14
37
15
-
app/console server:run 0.0.0.0:8000
38
+
app/console server:run 127.0.0.1:80002
39
+
40
+
[OK] Server listening on http://127.0.0.1:8002
41
+
42
+
// Quit the server with CONTROL-C.
16
43
17
-
After that, Mapbender is available from the host machine with the URL http://ip-address:8000/app.php.
44
+
[Mon Jan 31 15:56:57 2022] PHP 7.4.3 Development Server (http://127.0.0.1:8002) started
Copy file name to clipboardExpand all lines: en/installation/installation_ubuntu.rst
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,12 +5,12 @@ Installation on Ubuntu/Debian
5
5
6
6
Mapbender is shipped with a preconfigured SQLite database which includes preconfigured applications (the database is located under **<mapbender>/app/db/demo.sqlite**).
7
7
8
-
For productive use PostgreSQL is recommended. You can find the neccessary configuration steps in chapter `Optional > Mapbender Deployment on PostgreSQL <#optional>`_.
8
+
.. hint:: For productive use PostgreSQL is recommended. You can find the neccessary configuration steps in chapter `Optional > Mapbender Deployment on PostgreSQL <#optional>`_.
9
9
10
10
Requirements
11
11
------------
12
12
13
-
- PHP (from version 5.6 to 7.2)
13
+
- PHP >= 7.1
14
14
- Apache installation with the following modules activated:
15
15
16
16
* mod_rewrite
@@ -32,7 +32,7 @@ Installation of mandatory PHP extensions:
32
32
Unpack and register to web server
33
33
---------------------------------
34
34
35
-
Download the current Mapbender version and unzip it into /var/www/mapbender:
35
+
Download the current Mapbender version and unzip it into /var/www/mapbender or a different location:
36
36
37
37
.. code-block:: bash
38
38
@@ -87,7 +87,7 @@ Directory rights
87
87
First steps
88
88
-----------
89
89
90
-
The Mapbender installation can now be accessed under **http://hostname/mapbender/**.
90
+
The Mapbender installation can now be accessed under **http://[hostname]/mapbender/**.
91
91
User data by default:
92
92
93
93
username: "root", password: "root"
@@ -120,9 +120,9 @@ To use the optional LDAP-connection, following PHP-LDAP-extension is required:
120
120
Configuration of PostgreSQL database for productive use:
121
121
122
122
Requirements:
123
-
- configured PostgreSQL database (version < 10)
123
+
- configured PostgreSQL database
124
124
- database for Mapbender configuration
125
-
- possibly user for access
125
+
- PostgreSQl database user to access the database with create database right
0 commit comments