diff --git a/.readthedocs.yml b/.readthedocs.yml deleted file mode 100644 index bc540d82754..00000000000 --- a/.readthedocs.yml +++ /dev/null @@ -1,19 +0,0 @@ -# .readthedocs.yml -# Read the Docs configuration file -# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details - -# Required -version: 2 - -# Build documentation in the docs/ directory with Sphinx -sphinx: - configuration: docs/conf.py - -# Optionally build your docs in additional formats such as PDF and ePub -formats: all - -# Optionally set the version of Python and requirements required to build your docs -python: - version: 3.7 - install: - - requirements: ./requirements_docs.txt diff --git a/docs/LICENSE b/docs/LICENSE deleted file mode 100644 index 6b9078071d9..00000000000 --- a/docs/LICENSE +++ /dev/null @@ -1,66 +0,0 @@ -CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE LEGAL SERVICES. DISTRIBUTION OF THIS LICENSE DOES NOT CREATE AN ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES REGARDING THE INFORMATION PROVIDED, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM ITS USE. -License - -THE WORK (AS DEFINED BELOW) IS PROVIDED UNDER THE TERMS OF THIS CREATIVE COMMONS PUBLIC LICENSE ("CCPL" OR "LICENSE"). THE WORK IS PROTECTED BY COPYRIGHT AND/OR OTHER APPLICABLE LAW. ANY USE OF THE WORK OTHER THAN AS AUTHORIZED UNDER THIS LICENSE OR COPYRIGHT LAW IS PROHIBITED. - -BY EXERCISING ANY RIGHTS TO THE WORK PROVIDED HERE, YOU ACCEPT AND AGREE TO BE BOUND BY THE TERMS OF THIS LICENSE. TO THE EXTENT THIS LICENSE MAY BE CONSIDERED TO BE A CONTRACT, THE LICENSOR GRANTS YOU THE RIGHTS CONTAINED HERE IN CONSIDERATION OF YOUR ACCEPTANCE OF SUCH TERMS AND CONDITIONS. - -1. Definitions - -"Adaptation" means a work based upon the Work, or upon the Work and other pre-existing works, such as a translation, adaptation, derivative work, arrangement of music or other alterations of a literary or artistic work, or phonogram or performance and includes cinematographic adaptations or any other form in which the Work may be recast, transformed, or adapted including in any form recognizably derived from the original, except that a work that constitutes a Collection will not be considered an Adaptation for the purpose of this License. For the avoidance of doubt, where the Work is a musical work, performance or phonogram, the synchronization of the Work in timed-relation with a moving image ("synching") will be considered an Adaptation for the purpose of this License. -"Collection" means a collection of literary or artistic works, such as encyclopedias and anthologies, or performances, phonograms or broadcasts, or other works or subject matter other than works listed in Section 1(f) below, which, by reason of the selection and arrangement of their contents, constitute intellectual creations, in which the Work is included in its entirety in unmodified form along with one or more other contributions, each constituting separate and independent works in themselves, which together are assembled into a collective whole. A work that constitutes a Collection will not be considered an Adaptation (as defined below) for the purposes of this License. -"Creative Commons Compatible License" means a license that is listed at https://creativecommons.org/compatiblelicenses that has been approved by Creative Commons as being essentially equivalent to this License, including, at a minimum, because that license: (i) contains terms that have the same purpose, meaning and effect as the License Elements of this License; and, (ii) explicitly permits the relicensing of adaptations of works made available under that license under this License or a Creative Commons jurisdiction license with the same License Elements as this License. -"Distribute" means to make available to the public the original and copies of the Work or Adaptation, as appropriate, through sale or other transfer of ownership. -"License Elements" means the following high-level license attributes as selected by Licensor and indicated in the title of this License: Attribution, ShareAlike. -"Licensor" means the individual, individuals, entity or entities that offer(s) the Work under the terms of this License. -"Original Author" means, in the case of a literary or artistic work, the individual, individuals, entity or entities who created the Work or if no individual or entity can be identified, the publisher; and in addition (i) in the case of a performance the actors, singers, musicians, dancers, and other persons who act, sing, deliver, declaim, play in, interpret or otherwise perform literary or artistic works or expressions of folklore; (ii) in the case of a phonogram the producer being the person or legal entity who first fixes the sounds of a performance or other sounds; and, (iii) in the case of broadcasts, the organization that transmits the broadcast. -"Work" means the literary and/or artistic work offered under the terms of this License including without limitation any production in the literary, scientific and artistic domain, whatever may be the mode or form of its expression including digital form, such as a book, pamphlet and other writing; a lecture, address, sermon or other work of the same nature; a dramatic or dramatico-musical work; a choreographic work or entertainment in dumb show; a musical composition with or without words; a cinematographic work to which are assimilated works expressed by a process analogous to cinematography; a work of drawing, painting, architecture, sculpture, engraving or lithography; a photographic work to which are assimilated works expressed by a process analogous to photography; a work of applied art; an illustration, map, plan, sketch or three-dimensional work relative to geography, topography, architecture or science; a performance; a broadcast; a phonogram; a compilation of data to the extent it is protected as a copyrightable work; or a work performed by a variety or circus performer to the extent it is not otherwise considered a literary or artistic work. -"You" means an individual or entity exercising rights under this License who has not previously violated the terms of this License with respect to the Work, or who has received express permission from the Licensor to exercise rights under this License despite a previous violation. -"Publicly Perform" means to perform public recitations of the Work and to communicate to the public those public recitations, by any means or process, including by wire or wireless means or public digital performances; to make available to the public Works in such a way that members of the public may access these Works from a place and at a place individually chosen by them; to perform the Work to the public by any means or process and the communication to the public of the performances of the Work, including by public digital performance; to broadcast and rebroadcast the Work by any means including signs, sounds or images. -"Reproduce" means to make copies of the Work by any means including without limitation by sound or visual recordings and the right of fixation and reproducing fixations of the Work, including storage of a protected performance or phonogram in digital form or other electronic medium. -2. Fair Dealing Rights. Nothing in this License is intended to reduce, limit, or restrict any uses free from copyright or rights arising from limitations or exceptions that are provided for in connection with the copyright protection under copyright law or other applicable laws. - -3. License Grant. Subject to the terms and conditions of this License, Licensor hereby grants You a worldwide, royalty-free, non-exclusive, perpetual (for the duration of the applicable copyright) license to exercise the rights in the Work as stated below: - -to Reproduce the Work, to incorporate the Work into one or more Collections, and to Reproduce the Work as incorporated in the Collections; -to create and Reproduce Adaptations provided that any such Adaptation, including any translation in any medium, takes reasonable steps to clearly label, demarcate or otherwise identify that changes were made to the original Work. For example, a translation could be marked "The original work was translated from English to Spanish," or a modification could indicate "The original work has been modified."; -to Distribute and Publicly Perform the Work including as incorporated in Collections; and, -to Distribute and Publicly Perform Adaptations. -For the avoidance of doubt: - -Non-waivable Compulsory License Schemes. In those jurisdictions in which the right to collect royalties through any statutory or compulsory licensing scheme cannot be waived, the Licensor reserves the exclusive right to collect such royalties for any exercise by You of the rights granted under this License; -Waivable Compulsory License Schemes. In those jurisdictions in which the right to collect royalties through any statutory or compulsory licensing scheme can be waived, the Licensor waives the exclusive right to collect such royalties for any exercise by You of the rights granted under this License; and, -Voluntary License Schemes. The Licensor waives the right to collect royalties, whether individually or, in the event that the Licensor is a member of a collecting society that administers voluntary licensing schemes, via that society, from any exercise by You of the rights granted under this License. -The above rights may be exercised in all media and formats whether now known or hereafter devised. The above rights include the right to make such modifications as are technically necessary to exercise the rights in other media and formats. Subject to Section 8(f), all rights not expressly granted by Licensor are hereby reserved. - -4. Restrictions. The license granted in Section 3 above is expressly made subject to and limited by the following restrictions: - -You may Distribute or Publicly Perform the Work only under the terms of this License. You must include a copy of, or the Uniform Resource Identifier (URI) for, this License with every copy of the Work You Distribute or Publicly Perform. You may not offer or impose any terms on the Work that restrict the terms of this License or the ability of the recipient of the Work to exercise the rights granted to that recipient under the terms of the License. You may not sublicense the Work. You must keep intact all notices that refer to this License and to the disclaimer of warranties with every copy of the Work You Distribute or Publicly Perform. When You Distribute or Publicly Perform the Work, You may not impose any effective technological measures on the Work that restrict the ability of a recipient of the Work from You to exercise the rights granted to that recipient under the terms of the License. This Section 4(a) applies to the Work as incorporated in a Collection, but this does not require the Collection apart from the Work itself to be made subject to the terms of this License. If You create a Collection, upon notice from any Licensor You must, to the extent practicable, remove from the Collection any credit as required by Section 4(c), as requested. If You create an Adaptation, upon notice from any Licensor You must, to the extent practicable, remove from the Adaptation any credit as required by Section 4(c), as requested. -You may Distribute or Publicly Perform an Adaptation only under the terms of: (i) this License; (ii) a later version of this License with the same License Elements as this License; (iii) a Creative Commons jurisdiction license (either this or a later license version) that contains the same License Elements as this License (e.g., Attribution-ShareAlike 3.0 US)); (iv) a Creative Commons Compatible License. If you license the Adaptation under one of the licenses mentioned in (iv), you must comply with the terms of that license. If you license the Adaptation under the terms of any of the licenses mentioned in (i), (ii) or (iii) (the "Applicable License"), you must comply with the terms of the Applicable License generally and the following provisions: (I) You must include a copy of, or the URI for, the Applicable License with every copy of each Adaptation You Distribute or Publicly Perform; (II) You may not offer or impose any terms on the Adaptation that restrict the terms of the Applicable License or the ability of the recipient of the Adaptation to exercise the rights granted to that recipient under the terms of the Applicable License; (III) You must keep intact all notices that refer to the Applicable License and to the disclaimer of warranties with every copy of the Work as included in the Adaptation You Distribute or Publicly Perform; (IV) when You Distribute or Publicly Perform the Adaptation, You may not impose any effective technological measures on the Adaptation that restrict the ability of a recipient of the Adaptation from You to exercise the rights granted to that recipient under the terms of the Applicable License. This Section 4(b) applies to the Adaptation as incorporated in a Collection, but this does not require the Collection apart from the Adaptation itself to be made subject to the terms of the Applicable License. -If You Distribute, or Publicly Perform the Work or any Adaptations or Collections, You must, unless a request has been made pursuant to Section 4(a), keep intact all copyright notices for the Work and provide, reasonable to the medium or means You are utilizing: (i) the name of the Original Author (or pseudonym, if applicable) if supplied, and/or if the Original Author and/or Licensor designate another party or parties (e.g., a sponsor institute, publishing entity, journal) for attribution ("Attribution Parties") in Licensor's copyright notice, terms of service or by other reasonable means, the name of such party or parties; (ii) the title of the Work if supplied; (iii) to the extent reasonably practicable, the URI, if any, that Licensor specifies to be associated with the Work, unless such URI does not refer to the copyright notice or licensing information for the Work; and (iv) , consistent with Ssection 3(b), in the case of an Adaptation, a credit identifying the use of the Work in the Adaptation (e.g., "French translation of the Work by Original Author," or "Screenplay based on original Work by Original Author"). The credit required by this Section 4(c) may be implemented in any reasonable manner; provided, however, that in the case of a Adaptation or Collection, at a minimum such credit will appear, if a credit for all contributing authors of the Adaptation or Collection appears, then as part of these credits and in a manner at least as prominent as the credits for the other contributing authors. For the avoidance of doubt, You may only use the credit required by this Section for the purpose of attribution in the manner set out above and, by exercising Your rights under this License, You may not implicitly or explicitly assert or imply any connection with, sponsorship or endorsement by the Original Author, Licensor and/or Attribution Parties, as appropriate, of You or Your use of the Work, without the separate, express prior written permission of the Original Author, Licensor and/or Attribution Parties. -Except as otherwise agreed in writing by the Licensor or as may be otherwise permitted by applicable law, if You Reproduce, Distribute or Publicly Perform the Work either by itself or as part of any Adaptations or Collections, You must not distort, mutilate, modify or take other derogatory action in relation to the Work which would be prejudicial to the Original Author's honor or reputation. Licensor agrees that in those jurisdictions (e.g. Japan), in which any exercise of the right granted in Section 3(b) of this License (the right to make Adaptations) would be deemed to be a distortion, mutilation, modification or other derogatory action prejudicial to the Original Author's honor and reputation, the Licensor will waive or not assert, as appropriate, this Section, to the fullest extent permitted by the applicable national law, to enable You to reasonably exercise Your right under Section 3(b) of this License (right to make Adaptations) but not otherwise. -5. Representations, Warranties and Disclaimer - -UNLESS OTHERWISE MUTUALLY AGREED TO BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE WORK, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU. - -6. Limitation on Liability. EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. - -7. Termination - -This License and the rights granted hereunder will terminate automatically upon any breach by You of the terms of this License. Individuals or entities who have received Adaptations or Collections from You under this License, however, will not have their licenses terminated provided such individuals or entities remain in full compliance with those licenses. Sections 1, 2, 5, 6, 7, and 8 will survive any termination of this License. -Subject to the above terms and conditions, the license granted here is perpetual (for the duration of the applicable copyright in the Work). Notwithstanding the above, Licensor reserves the right to release the Work under different license terms or to stop distributing the Work at any time; provided, however that any such election will not serve to withdraw this License (or any other license that has been, or is required to be, granted under the terms of this License), and this License will continue in full force and effect unless terminated as stated above. -8. Miscellaneous - -Each time You Distribute or Publicly Perform the Work or a Collection, the Licensor offers to the recipient a license to the Work on the same terms and conditions as the license granted to You under this License. -Each time You Distribute or Publicly Perform an Adaptation, Licensor offers to the recipient a license to the original Work on the same terms and conditions as the license granted to You under this License. -If any provision of this License is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this License, and without further action by the parties to this agreement, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable. -No term or provision of this License shall be deemed waived and no breach consented to unless such waiver or consent shall be in writing and signed by the party to be charged with such waiver or consent. -This License constitutes the entire agreement between the parties with respect to the Work licensed here. There are no understandings, agreements or representations with respect to the Work not specified here. Licensor shall not be bound by any additional provisions that may appear in any communication from You. This License may not be modified without the mutual written agreement of the Licensor and You. -The rights granted under, and the subject matter referenced, in this License were drafted utilizing the terminology of the Berne Convention for the Protection of Literary and Artistic Works (as amended on September 28, 1979), the Rome Convention of 1961, the WIPO Copyright Treaty of 1996, the WIPO Performances and Phonograms Treaty of 1996 and the Universal Copyright Convention (as revised on July 24, 1971). These rights and subject matter take effect in the relevant jurisdiction in which the License terms are sought to be enforced according to the corresponding provisions of the implementation of those treaty provisions in the applicable national law. If the standard suite of rights granted under applicable copyright law includes additional rights not granted under this License, such additional rights are deemed to be included in the License; this License is not intended to restrict the license of any rights under applicable law. -Creative Commons Notice - -Creative Commons is not a party to this License, and makes no warranty whatsoever in connection with the Work. Creative Commons will not be liable to You or any party on any legal theory for any damages whatsoever, including without limitation any general, special, incidental or consequential damages arising in connection to this license. Notwithstanding the foregoing two (2) sentences, if Creative Commons has expressly identified itself as the Licensor hereunder, it shall have all rights and obligations of Licensor. - -Except for the limited purpose of indicating to the public that the Work is licensed under the CCPL, Creative Commons does not authorize the use by either party of the trademark "Creative Commons" or any related trademark or logo of Creative Commons without the prior written consent of Creative Commons. Any permitted use will be in compliance with Creative Commons' then-current trademark usage guidelines, as may be published on its website or otherwise made available upon request from time to time. For the avoidance of doubt, this trademark restriction does not form part of the License. - -Creative Commons may be contacted at https://creativecommons.org/. \ No newline at end of file diff --git a/docs/Makefile b/docs/Makefile deleted file mode 100644 index cff5a0b13e9..00000000000 --- a/docs/Makefile +++ /dev/null @@ -1,139 +0,0 @@ -# Makefile for Sphinx documentation -# - -# You can set these variables from the command line. -LANG = en -SPHINXBUILD = sphinx-build -PAPER = -SOURCEDIR = . -BUILDDIR = _build/$(LANG) -SPHINXOPTS = -D language='$(LANG)' $(SOURCEDIR) - -# Internal variables. -PAPEROPT_a4 = -D latex_paper_size=a4 -PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) -I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) i18n/pot - -.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest - -help: - @echo "Please use \`make ' where is one of" - @echo " html to make standalone HTML files" - @echo " dirhtml to make HTML files named index.html in directories" - @echo " singlehtml to make a single large HTML file" - @echo " pickle to make pickle files" - @echo " json to make JSON files" - @echo " htmlhelp to make HTML files and a HTML help project" - @echo " qthelp to make HTML files and a qthelp project" - @echo " devhelp to make HTML files and a Devhelp project" - @echo " epub to make an epub" - @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" - @echo " latexpdf to make LaTeX files and run them through pdflatex" - @echo " text to make text files" - @echo " man to make manual pages" - @echo " gettext to make PO message catalogs" - @echo " changes to make an overview of all changed/added/deprecated items" - @echo " linkcheck to check all external links for integrity" - @echo " doctest to run all doctests embedded in the documentation (if enabled)" - -clean: - -rm -rf $(BUILDDIR)/* - -html: - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." - -dirhtml: - $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." - -singlehtml: - $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml - @echo - @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." - -pickle: - $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle - @echo - @echo "Build finished; now you can process the pickle files." - -json: - $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json - @echo - @echo "Build finished; now you can process the JSON files." - -htmlhelp: - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp - @echo - @echo "Build finished; now you can run HTML Help Workshop with the" \ - ".hhp project file in $(BUILDDIR)/htmlhelp." - -qthelp: - $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp - @echo - @echo "Build finished; now you can run "qcollectiongenerator" with the" \ - ".qhcp project file in $(BUILDDIR)/qthelp, like this:" - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/GeoNode.qhcp" - @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/GeoNode.qhc" - -devhelp: - $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp - @echo - @echo "Build finished." - @echo "To view the help file:" - @echo "# mkdir -p $$HOME/.local/share/devhelp/GeoNode" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/GeoNode" - @echo "# devhelp" - -epub: - $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub - @echo - @echo "Build finished. The epub file is in $(BUILDDIR)/epub." - -latex: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo - @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." - @echo "Run \`make' in that directory to run these through (pdf)latex" \ - "(use \`make latexpdf' here to do that automatically)." - -latexpdf: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through pdflatex..." - make -C $(BUILDDIR)/latex all-pdf - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -text: - $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text - @echo - @echo "Build finished. The text files are in $(BUILDDIR)/text." - -man: - $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man - @echo - @echo "Build finished. The manual pages are in $(BUILDDIR)/man." - -changes: - $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes - @echo - @echo "The overview file is in $(BUILDDIR)/changes." - -linkcheck: - $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck - @echo - @echo "Link check complete; look for any errors in the above output " \ - "or in $(BUILDDIR)/linkcheck/output.txt." - -doctest: - $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest - @echo "Testing of doctests in the sources finished, look at the " \ - "results in $(BUILDDIR)/doctest/output.txt." - -gettext: - $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) - @echo - @echo "Build finished." diff --git a/docs/about/img/geonode-logo_for_readme.gif b/docs/about/img/geonode-logo_for_readme.gif deleted file mode 100644 index 8b85f19541d..00000000000 Binary files a/docs/about/img/geonode-logo_for_readme.gif and /dev/null differ diff --git a/docs/about/img/logo.png b/docs/about/img/logo.png deleted file mode 100644 index b2e7cac4243..00000000000 Binary files a/docs/about/img/logo.png and /dev/null differ diff --git a/docs/about/index.rst b/docs/about/index.rst deleted file mode 100644 index 3e29900ff83..00000000000 --- a/docs/about/index.rst +++ /dev/null @@ -1,90 +0,0 @@ -What is GeoNode -=============== - -.. image:: img/logo.png - -GeoNode is a geospatial content management system, a platform for the management and publication of geospatial data. It brings together mature and stable open-source software projects under a consistent and easy-to-use interface allowing non-specialized users to share data and create interactive maps. - -Data management tools built into GeoNode allow for integrated creation of data, metadata, and map visualization. Each dataset in the system can be shared publicly or restricted to allow access to only specific users. Social features like user profiles and commenting and rating systems allow for the development of communities around each platform to facilitate the use, management, and quality control of the data the GeoNode instance contains. - -It is also designed to be a flexible platform that software developers can extend, modify or integrate against to meet requirements in their own applications. - -Showcase --------- - -A handful of other Open Source projects extend GeoNode’s functionality -by tapping into the re-usability of Django applications. -Visit our gallery to see how the community uses GeoNode: `GeoNode Showcase `_. - -The development community is very supportive of new projects and contributes ideas and guidance for newcomers. - -For a live demo see also :ref:`online_demo` - -Most useful links ------------------ - -**General** - -- Project homepage: https://geonode.org -- Repository: https://github.com/GeoNode/geonode -- Offical Demo: http://master.demo.geonode.org -- GeoNode Wiki: https://github.com/GeoNode/geonode/wiki -- Issue tracker: https://github.com/GeoNode/geonode-project/issues - - In case of sensitive bugs like security vulnerabilities, please - contact a GeoNode Core Developer directly instead of using issue - tracker. We value your effort to improve the security and privacy of - this project! - -**Related projects** - -- GeoNode Project: https://github.com/GeoNode/geonode-project -- GeoNode at Docker: https://hub.docker.com/u/geonode -- GeoNode OSGeo-Live: https://live.osgeo.org/en/ - - -Licensing -========= - -GeoNode is Copyright 2018 Open Source Geospatial Foundation (OSGeo). - -GeoNode is free software: you can redistribute it and/or modify it under -the terms of the GNU General Public License as published by the Free -Software Foundation, either version 3 of the License, or (at your -option) any later version. GeoNode is distributed in the hope that it -will be useful, but WITHOUT ANY WARRANTY; without even the implied -warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU General Public License for more details. - -You should have received a copy of the GNU General Public License along -with GeoNode. If not, see http://www.gnu.org/licenses. - -Current Version and Features -============================ - -GeoNode current version: `2.10 `_ - -Main Features: `State of GeoNode 2.10 `_ - -.. _get_in_touch: - -Get in touch with the community -=============================== - -GeoNode is an open source project and contributors are needed to keep this project moving forward. Learn more on how to contribute on our -`Community Bylaws `_. - -- User Mailing List: https://lists.osgeo.org/cgi-bin/mailman/listinfo/geonode-users -- Developer Mailing List: https://lists.osgeo.org/cgi-bin/mailman/listinfo/geonode-devel -- Gitter Chat: https://gitter.im/GeoNode/general - -Roadmap -======= - -GeoNode's development roadmap is documented in a series of GeoNode Improvement Projects (GNIPS). -They are documented at `GeoNode Wiki `_. - -GNIPS are considered to be large undertakings which will add a large amount of features to the project. -As such they are the topic of community dicussion and guidance. - -The community discusses these on the developer mailing list: http://lists.osgeo.org/pipermail/geonode-devel/ diff --git a/docs/admin/admin_panel/img/add_new_member.png b/docs/admin/admin_panel/img/add_new_member.png deleted file mode 100644 index 7cf69332280..00000000000 Binary files a/docs/admin/admin_panel/img/add_new_member.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/add_user_button.png b/docs/admin/admin_panel/img/add_user_button.png deleted file mode 100644 index f8808e61083..00000000000 Binary files a/docs/admin/admin_panel/img/add_user_button.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/add_user_form.png b/docs/admin/admin_panel/img/add_user_form.png deleted file mode 100644 index f4ead6ffa2c..00000000000 Binary files a/docs/admin/admin_panel/img/add_user_form.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/add_user_link.png b/docs/admin/admin_panel/img/add_user_link.png deleted file mode 100644 index 83721ebcfd6..00000000000 Binary files a/docs/admin/admin_panel/img/add_user_link.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/admin-documents.png b/docs/admin/admin_panel/img/admin-documents.png deleted file mode 100644 index 72848ecf164..00000000000 Binary files a/docs/admin/admin_panel/img/admin-documents.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/admin-layers-batch.png b/docs/admin/admin_panel/img/admin-layers-batch.png deleted file mode 100644 index c44015bd546..00000000000 Binary files a/docs/admin/admin_panel/img/admin-layers-batch.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/admin-layers.png b/docs/admin/admin_panel/img/admin-layers.png deleted file mode 100644 index a3c6d2d08b7..00000000000 Binary files a/docs/admin/admin_panel/img/admin-layers.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/admin-maps-featured-001.png b/docs/admin/admin_panel/img/admin-maps-featured-001.png deleted file mode 100644 index 690a3288b28..00000000000 Binary files a/docs/admin/admin_panel/img/admin-maps-featured-001.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/admin-maps-featured-002.png b/docs/admin/admin_panel/img/admin-maps-featured-002.png deleted file mode 100644 index b12ad04f38e..00000000000 Binary files a/docs/admin/admin_panel/img/admin-maps-featured-002.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/admin-maps.png b/docs/admin/admin_panel/img/admin-maps.png deleted file mode 100644 index 76ff9d34496..00000000000 Binary files a/docs/admin/admin_panel/img/admin-maps.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/admin-panel-menus-0000.png b/docs/admin/admin_panel/img/admin-panel-menus-0000.png deleted file mode 100644 index 0cf7374e98f..00000000000 Binary files a/docs/admin/admin_panel/img/admin-panel-menus-0000.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/admin-panel-menus-0001.png b/docs/admin/admin_panel/img/admin-panel-menus-0001.png deleted file mode 100644 index ab4d21d6b9a..00000000000 Binary files a/docs/admin/admin_panel/img/admin-panel-menus-0001.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/admin-panel-menus-0002.png b/docs/admin/admin_panel/img/admin-panel-menus-0002.png deleted file mode 100644 index e56f5a0eb78..00000000000 Binary files a/docs/admin/admin_panel/img/admin-panel-menus-0002.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/admin-panel-menus-0003.png b/docs/admin/admin_panel/img/admin-panel-menus-0003.png deleted file mode 100644 index 633c9f076e1..00000000000 Binary files a/docs/admin/admin_panel/img/admin-panel-menus-0003.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/admin-panel-menus-0004.png b/docs/admin/admin_panel/img/admin-panel-menus-0004.png deleted file mode 100644 index e08049ac562..00000000000 Binary files a/docs/admin/admin_panel/img/admin-panel-menus-0004.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/admin-people.png b/docs/admin/admin_panel/img/admin-people.png deleted file mode 100644 index 9ca6d92d030..00000000000 Binary files a/docs/admin/admin_panel/img/admin-people.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/admin-profiles-contactroles.png b/docs/admin/admin_panel/img/admin-profiles-contactroles.png deleted file mode 100644 index e63835ad10a..00000000000 Binary files a/docs/admin/admin_panel/img/admin-profiles-contactroles.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/admin-roles-add.png b/docs/admin/admin_panel/img/admin-roles-add.png deleted file mode 100644 index f0e71830039..00000000000 Binary files a/docs/admin/admin_panel/img/admin-roles-add.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/admin_link.png b/docs/admin/admin_panel/img/admin_link.png deleted file mode 100644 index 5262cb1416f..00000000000 Binary files a/docs/admin/admin_panel/img/admin_link.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/adv_data_workflow/adv_data_workflow_001.jpg b/docs/admin/admin_panel/img/adv_data_workflow/adv_data_workflow_001.jpg deleted file mode 100644 index 40e585aad22..00000000000 Binary files a/docs/admin/admin_panel/img/adv_data_workflow/adv_data_workflow_001.jpg and /dev/null differ diff --git a/docs/admin/admin_panel/img/adv_data_workflow/approbation_manager.gif b/docs/admin/admin_panel/img/adv_data_workflow/approbation_manager.gif deleted file mode 100644 index f188e791442..00000000000 Binary files a/docs/admin/admin_panel/img/adv_data_workflow/approbation_manager.gif and /dev/null differ diff --git a/docs/admin/admin_panel/img/adv_data_workflow/unpublished.png b/docs/admin/admin_panel/img/adv_data_workflow/unpublished.png deleted file mode 100644 index 5671c41cab0..00000000000 Binary files a/docs/admin/admin_panel/img/adv_data_workflow/unpublished.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/announcments/admin-announcments-001.png b/docs/admin/admin_panel/img/announcments/admin-announcments-001.png deleted file mode 100644 index 31c9210465c..00000000000 Binary files a/docs/admin/admin_panel/img/announcments/admin-announcments-001.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/announcments/admin-announcments-002.png b/docs/admin/admin_panel/img/announcments/admin-announcments-002.png deleted file mode 100644 index e7b657ed862..00000000000 Binary files a/docs/admin/admin_panel/img/announcments/admin-announcments-002.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/announcments/admin-announcments-003.png b/docs/admin/admin_panel/img/announcments/admin-announcments-003.png deleted file mode 100644 index 88eb81933db..00000000000 Binary files a/docs/admin/admin_panel/img/announcments/admin-announcments-003.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/announcments/admin-announcments-004.png b/docs/admin/admin_panel/img/announcments/admin-announcments-004.png deleted file mode 100644 index 7fb74c61dfa..00000000000 Binary files a/docs/admin/admin_panel/img/announcments/admin-announcments-004.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/announcments/admin-announcments-005.png b/docs/admin/admin_panel/img/announcments/admin-announcments-005.png deleted file mode 100644 index 838b9eac213..00000000000 Binary files a/docs/admin/admin_panel/img/announcments/admin-announcments-005.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/announcments/admin-announcments-006.png b/docs/admin/admin_panel/img/announcments/admin-announcments-006.png deleted file mode 100644 index fd6e7d8b445..00000000000 Binary files a/docs/admin/admin_panel/img/announcments/admin-announcments-006.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/announcments/admin-announcments-007.png b/docs/admin/admin_panel/img/announcments/admin-announcments-007.png deleted file mode 100644 index d0a7304122c..00000000000 Binary files a/docs/admin/admin_panel/img/announcments/admin-announcments-007.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/announcments/admin-announcments-008.png b/docs/admin/admin_panel/img/announcments/admin-announcments-008.png deleted file mode 100644 index 3c7ac04965e..00000000000 Binary files a/docs/admin/admin_panel/img/announcments/admin-announcments-008.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/announcments/admin-announcments-009.png b/docs/admin/admin_panel/img/announcments/admin-announcments-009.png deleted file mode 100644 index c968cdab37f..00000000000 Binary files a/docs/admin/admin_panel/img/announcments/admin-announcments-009.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/announcments/admin-announcments-010.png b/docs/admin/admin_panel/img/announcments/admin-announcments-010.png deleted file mode 100644 index f199a28affc..00000000000 Binary files a/docs/admin/admin_panel/img/announcments/admin-announcments-010.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/change_password_form.png b/docs/admin/admin_panel/img/change_password_form.png deleted file mode 100644 index 3f7b073cb95..00000000000 Binary files a/docs/admin/admin_panel/img/change_password_form.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/change_password_link.png b/docs/admin/admin_panel/img/change_password_link.png deleted file mode 100644 index a0ba2bef90b..00000000000 Binary files a/docs/admin/admin_panel/img/change_password_link.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/change_user_password_link.png b/docs/admin/admin_panel/img/change_user_password_link.png deleted file mode 100644 index 5f98b875b50..00000000000 Binary files a/docs/admin/admin_panel/img/change_user_password_link.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/chenge_user_password_form.png b/docs/admin/admin_panel/img/chenge_user_password_form.png deleted file mode 100644 index f3b787a7986..00000000000 Binary files a/docs/admin/admin_panel/img/chenge_user_password_form.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/confirm_group_deletion.png b/docs/admin/admin_panel/img/confirm_group_deletion.png deleted file mode 100644 index 536bb1110b1..00000000000 Binary files a/docs/admin/admin_panel/img/confirm_group_deletion.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/create_group_page_link.png b/docs/admin/admin_panel/img/create_group_page_link.png deleted file mode 100644 index ebdbb45886b..00000000000 Binary files a/docs/admin/admin_panel/img/create_group_page_link.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/django_geonode_admin_interface.png b/docs/admin/admin_panel/img/django_geonode_admin_interface.png deleted file mode 100644 index 5c2e9d8603a..00000000000 Binary files a/docs/admin/admin_panel/img/django_geonode_admin_interface.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/editing_group_logo.png b/docs/admin/admin_panel/img/editing_group_logo.png deleted file mode 100644 index 1dc825b422f..00000000000 Binary files a/docs/admin/admin_panel/img/editing_group_logo.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/group_activities.png b/docs/admin/admin_panel/img/group_activities.png deleted file mode 100644 index 27c6340bf9e..00000000000 Binary files a/docs/admin/admin_panel/img/group_activities.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/group_categories_list.png b/docs/admin/admin_panel/img/group_categories_list.png deleted file mode 100644 index 7e60d423cf8..00000000000 Binary files a/docs/admin/admin_panel/img/group_categories_list.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/group_creation_form.png b/docs/admin/admin_panel/img/group_creation_form.png deleted file mode 100644 index b01c5d1f11e..00000000000 Binary files a/docs/admin/admin_panel/img/group_creation_form.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/group_details_page.png b/docs/admin/admin_panel/img/group_details_page.png deleted file mode 100644 index 9e2e78d96c9..00000000000 Binary files a/docs/admin/admin_panel/img/group_details_page.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/group_logo.png b/docs/admin/admin_panel/img/group_logo.png deleted file mode 100644 index b2cc96e1156..00000000000 Binary files a/docs/admin/admin_panel/img/group_logo.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/group_profile_details_page.png b/docs/admin/admin_panel/img/group_profile_details_page.png deleted file mode 100644 index 8eacdcc9a7d..00000000000 Binary files a/docs/admin/admin_panel/img/group_profile_details_page.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/group_profiles_list.png b/docs/admin/admin_panel/img/group_profiles_list.png deleted file mode 100644 index 94818b8f07c..00000000000 Binary files a/docs/admin/admin_panel/img/group_profiles_list.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/group_profiles_list_page.png b/docs/admin/admin_panel/img/group_profiles_list_page.png deleted file mode 100644 index 41d01fd86c7..00000000000 Binary files a/docs/admin/admin_panel/img/group_profiles_list_page.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/groups_admin_section.png b/docs/admin/admin_panel/img/groups_admin_section.png deleted file mode 100644 index ecdcc8d3d58..00000000000 Binary files a/docs/admin/admin_panel/img/groups_admin_section.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/groups_link.png b/docs/admin/admin_panel/img/groups_link.png deleted file mode 100644 index 7b0f185220a..00000000000 Binary files a/docs/admin/admin_panel/img/groups_link.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/groups_list_page.png b/docs/admin/admin_panel/img/groups_list_page.png deleted file mode 100644 index a874263b1f5..00000000000 Binary files a/docs/admin/admin_panel/img/groups_list_page.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/groups_page_link.png b/docs/admin/admin_panel/img/groups_page_link.png deleted file mode 100644 index 32f549e4991..00000000000 Binary files a/docs/admin/admin_panel/img/groups_page_link.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/layers_group_category.png b/docs/admin/admin_panel/img/layers_group_category.png deleted file mode 100644 index dab959dc0ec..00000000000 Binary files a/docs/admin/admin_panel/img/layers_group_category.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/metadata-base/admin-panel-metadata-contents-0001.png b/docs/admin/admin_panel/img/metadata-base/admin-panel-metadata-contents-0001.png deleted file mode 100644 index 6f55d401c2c..00000000000 Binary files a/docs/admin/admin_panel/img/metadata-base/admin-panel-metadata-contents-0001.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/metadata-base/admin-panel-metadata-contents-0002.png b/docs/admin/admin_panel/img/metadata-base/admin-panel-metadata-contents-0002.png deleted file mode 100644 index 94e7daae223..00000000000 Binary files a/docs/admin/admin_panel/img/metadata-base/admin-panel-metadata-contents-0002.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/metadata-base/admin-panel-metadata-contents-0003.png b/docs/admin/admin_panel/img/metadata-base/admin-panel-metadata-contents-0003.png deleted file mode 100644 index 23ea468c7cf..00000000000 Binary files a/docs/admin/admin_panel/img/metadata-base/admin-panel-metadata-contents-0003.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/metadata-base/admin-panel-metadata-contents-0003a.png b/docs/admin/admin_panel/img/metadata-base/admin-panel-metadata-contents-0003a.png deleted file mode 100644 index 8cc96626d62..00000000000 Binary files a/docs/admin/admin_panel/img/metadata-base/admin-panel-metadata-contents-0003a.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/metadata-base/admin-panel-metadata-contents-0004.png b/docs/admin/admin_panel/img/metadata-base/admin-panel-metadata-contents-0004.png deleted file mode 100644 index acd4657fdbb..00000000000 Binary files a/docs/admin/admin_panel/img/metadata-base/admin-panel-metadata-contents-0004.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/metadata-base/admin-panel-metadata-contents-0005.png b/docs/admin/admin_panel/img/metadata-base/admin-panel-metadata-contents-0005.png deleted file mode 100644 index 384f6cd4a93..00000000000 Binary files a/docs/admin/admin_panel/img/metadata-base/admin-panel-metadata-contents-0005.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/metadata-base/admin-panel-metadata-contents-0006.png b/docs/admin/admin_panel/img/metadata-base/admin-panel-metadata-contents-0006.png deleted file mode 100644 index a3f5cf7a643..00000000000 Binary files a/docs/admin/admin_panel/img/metadata-base/admin-panel-metadata-contents-0006.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/metadata-base/admin-panel-metadata-contents-0007.png b/docs/admin/admin_panel/img/metadata-base/admin-panel-metadata-contents-0007.png deleted file mode 100644 index 55f91d71ed7..00000000000 Binary files a/docs/admin/admin_panel/img/metadata-base/admin-panel-metadata-contents-0007.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/metadata-base/admin-panel-metadata-contents-0008.png b/docs/admin/admin_panel/img/metadata-base/admin-panel-metadata-contents-0008.png deleted file mode 100644 index 77e65515736..00000000000 Binary files a/docs/admin/admin_panel/img/metadata-base/admin-panel-metadata-contents-0008.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/metadata-base/admin-panel-metadata-contents-0009.png b/docs/admin/admin_panel/img/metadata-base/admin-panel-metadata-contents-0009.png deleted file mode 100644 index 900a0cf6f1b..00000000000 Binary files a/docs/admin/admin_panel/img/metadata-base/admin-panel-metadata-contents-0009.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/metadata-base/admin-panel-metadata-contents-0010.png b/docs/admin/admin_panel/img/metadata-base/admin-panel-metadata-contents-0010.png deleted file mode 100644 index 54261dc466c..00000000000 Binary files a/docs/admin/admin_panel/img/metadata-base/admin-panel-metadata-contents-0010.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/new_group_category_form.png b/docs/admin/admin_panel/img/new_group_category_form.png deleted file mode 100644 index 1e46b0c5779..00000000000 Binary files a/docs/admin/admin_panel/img/new_group_category_form.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/new_group_profile_form.png b/docs/admin/admin_panel/img/new_group_profile_form.png deleted file mode 100644 index 1552321ab80..00000000000 Binary files a/docs/admin/admin_panel/img/new_group_profile_form.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/new_members.png b/docs/admin/admin_panel/img/new_members.png deleted file mode 100644 index 189b19e2da5..00000000000 Binary files a/docs/admin/admin_panel/img/new_members.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/new_user_active.png b/docs/admin/admin_panel/img/new_user_active.png deleted file mode 100644 index 9e0a59654b1..00000000000 Binary files a/docs/admin/admin_panel/img/new_user_active.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/new_user_disabled.png b/docs/admin/admin_panel/img/new_user_disabled.png deleted file mode 100644 index 4a38900f25a..00000000000 Binary files a/docs/admin/admin_panel/img/new_user_disabled.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/new_user_in_people.png b/docs/admin/admin_panel/img/new_user_in_people.png deleted file mode 100644 index 3b965d2a2a3..00000000000 Binary files a/docs/admin/admin_panel/img/new_user_in_people.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/oauth2-tokens/admin-panel-tokens-0001.png b/docs/admin/admin_panel/img/oauth2-tokens/admin-panel-tokens-0001.png deleted file mode 100644 index 9cd81c9d64f..00000000000 Binary files a/docs/admin/admin_panel/img/oauth2-tokens/admin-panel-tokens-0001.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/oauth2-tokens/admin-panel-tokens-0002.png b/docs/admin/admin_panel/img/oauth2-tokens/admin-panel-tokens-0002.png deleted file mode 100644 index a1ad58364b7..00000000000 Binary files a/docs/admin/admin_panel/img/oauth2-tokens/admin-panel-tokens-0002.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/oauth2-tokens/admin-panel-tokens-0003.png b/docs/admin/admin_panel/img/oauth2-tokens/admin-panel-tokens-0003.png deleted file mode 100644 index 8a47d3063f1..00000000000 Binary files a/docs/admin/admin_panel/img/oauth2-tokens/admin-panel-tokens-0003.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/oauth2-tokens/admin-panel-tokens-0003a.png b/docs/admin/admin_panel/img/oauth2-tokens/admin-panel-tokens-0003a.png deleted file mode 100644 index 7dfa815f8d1..00000000000 Binary files a/docs/admin/admin_panel/img/oauth2-tokens/admin-panel-tokens-0003a.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/oauth2-tokens/admin-panel-tokens-0003b.png b/docs/admin/admin_panel/img/oauth2-tokens/admin-panel-tokens-0003b.png deleted file mode 100644 index 9ee4db5d7df..00000000000 Binary files a/docs/admin/admin_panel/img/oauth2-tokens/admin-panel-tokens-0003b.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/oauth2-tokens/admin-panel-tokens-0003c.png b/docs/admin/admin_panel/img/oauth2-tokens/admin-panel-tokens-0003c.png deleted file mode 100644 index 7f16b04acf7..00000000000 Binary files a/docs/admin/admin_panel/img/oauth2-tokens/admin-panel-tokens-0003c.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/oauth2-tokens/admin-panel-tokens-0003d.png b/docs/admin/admin_panel/img/oauth2-tokens/admin-panel-tokens-0003d.png deleted file mode 100644 index 751ed52c20b..00000000000 Binary files a/docs/admin/admin_panel/img/oauth2-tokens/admin-panel-tokens-0003d.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/oauth2-tokens/admin-panel-tokens-0003e.png b/docs/admin/admin_panel/img/oauth2-tokens/admin-panel-tokens-0003e.png deleted file mode 100644 index 2caf9958a64..00000000000 Binary files a/docs/admin/admin_panel/img/oauth2-tokens/admin-panel-tokens-0003e.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/set_layers_permissions_action.png b/docs/admin/admin_panel/img/set_layers_permissions_action.png deleted file mode 100644 index cd675a0b0e5..00000000000 Binary files a/docs/admin/admin_panel/img/set_layers_permissions_action.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/set_layers_permissions_form.png b/docs/admin/admin_panel/img/set_layers_permissions_form.png deleted file mode 100644 index 358e3365264..00000000000 Binary files a/docs/admin/admin_panel/img/set_layers_permissions_form.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/staff_and_superuser_permissions.png b/docs/admin/admin_panel/img/staff_and_superuser_permissions.png deleted file mode 100644 index 117896db0a6..00000000000 Binary files a/docs/admin/admin_panel/img/staff_and_superuser_permissions.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/theming/theme-def-0001.png b/docs/admin/admin_panel/img/theming/theme-def-0001.png deleted file mode 100644 index e1c6ba1f9a1..00000000000 Binary files a/docs/admin/admin_panel/img/theming/theme-def-0001.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/theming/theme-def-0002.png b/docs/admin/admin_panel/img/theming/theme-def-0002.png deleted file mode 100644 index 4e47dae161e..00000000000 Binary files a/docs/admin/admin_panel/img/theming/theme-def-0002.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/theming/theme-def-0003.png b/docs/admin/admin_panel/img/theming/theme-def-0003.png deleted file mode 100644 index 42da32386e3..00000000000 Binary files a/docs/admin/admin_panel/img/theming/theme-def-0003.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/theming/theme-def-0003a.png b/docs/admin/admin_panel/img/theming/theme-def-0003a.png deleted file mode 100644 index a564a584ba0..00000000000 Binary files a/docs/admin/admin_panel/img/theming/theme-def-0003a.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/theming/theme-def-0003b.png b/docs/admin/admin_panel/img/theming/theme-def-0003b.png deleted file mode 100644 index a3d8a31ac13..00000000000 Binary files a/docs/admin/admin_panel/img/theming/theme-def-0003b.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/theming/theme-def-0003c.png b/docs/admin/admin_panel/img/theming/theme-def-0003c.png deleted file mode 100644 index afcc77892df..00000000000 Binary files a/docs/admin/admin_panel/img/theming/theme-def-0003c.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/theming/theme-def-0003d.png b/docs/admin/admin_panel/img/theming/theme-def-0003d.png deleted file mode 100644 index 885a11404b5..00000000000 Binary files a/docs/admin/admin_panel/img/theming/theme-def-0003d.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/theming/theme-def-0003e.png b/docs/admin/admin_panel/img/theming/theme-def-0003e.png deleted file mode 100644 index b8503b0fd4a..00000000000 Binary files a/docs/admin/admin_panel/img/theming/theme-def-0003e.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/theming/theme-def-0004.png b/docs/admin/admin_panel/img/theming/theme-def-0004.png deleted file mode 100644 index 1754762c893..00000000000 Binary files a/docs/admin/admin_panel/img/theming/theme-def-0004.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/theming/theme-def-0004a.png b/docs/admin/admin_panel/img/theming/theme-def-0004a.png deleted file mode 100644 index 7eb01aae124..00000000000 Binary files a/docs/admin/admin_panel/img/theming/theme-def-0004a.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/theming/theme-def-0004b.png b/docs/admin/admin_panel/img/theming/theme-def-0004b.png deleted file mode 100644 index 842c4260d57..00000000000 Binary files a/docs/admin/admin_panel/img/theming/theme-def-0004b.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/theming/theme-def-0004c.png b/docs/admin/admin_panel/img/theming/theme-def-0004c.png deleted file mode 100644 index 4d03a83e754..00000000000 Binary files a/docs/admin/admin_panel/img/theming/theme-def-0004c.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/theming/theme-def-0004d.png b/docs/admin/admin_panel/img/theming/theme-def-0004d.png deleted file mode 100644 index 3c4ec3ec1d8..00000000000 Binary files a/docs/admin/admin_panel/img/theming/theme-def-0004d.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/theming/theme-def-0005.png b/docs/admin/admin_panel/img/theming/theme-def-0005.png deleted file mode 100644 index a4e8e707afb..00000000000 Binary files a/docs/admin/admin_panel/img/theming/theme-def-0005.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/theming/theme-def-0005a.png b/docs/admin/admin_panel/img/theming/theme-def-0005a.png deleted file mode 100644 index aa931aefef0..00000000000 Binary files a/docs/admin/admin_panel/img/theming/theme-def-0005a.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/theming/theme-def-0005b.png b/docs/admin/admin_panel/img/theming/theme-def-0005b.png deleted file mode 100644 index fad1896b5d3..00000000000 Binary files a/docs/admin/admin_panel/img/theming/theme-def-0005b.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/theming/theme-def-0005c.png b/docs/admin/admin_panel/img/theming/theme-def-0005c.png deleted file mode 100644 index 85cfd2eb85e..00000000000 Binary files a/docs/admin/admin_panel/img/theming/theme-def-0005c.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/theming/theme-def-0006.png b/docs/admin/admin_panel/img/theming/theme-def-0006.png deleted file mode 100644 index 0a245358cf6..00000000000 Binary files a/docs/admin/admin_panel/img/theming/theme-def-0006.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/theming/theme-def-0006a.png b/docs/admin/admin_panel/img/theming/theme-def-0006a.png deleted file mode 100644 index cf6439d9e84..00000000000 Binary files a/docs/admin/admin_panel/img/theming/theme-def-0006a.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/theming/theme-def-0006b.png b/docs/admin/admin_panel/img/theming/theme-def-0006b.png deleted file mode 100644 index 6f5abd508b8..00000000000 Binary files a/docs/admin/admin_panel/img/theming/theme-def-0006b.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/theming/theme-def-0006c.png b/docs/admin/admin_panel/img/theming/theme-def-0006c.png deleted file mode 100644 index 5edf6ca6eb1..00000000000 Binary files a/docs/admin/admin_panel/img/theming/theme-def-0006c.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/theming/themes.png b/docs/admin/admin_panel/img/theming/themes.png deleted file mode 100644 index 09ac2bc0883..00000000000 Binary files a/docs/admin/admin_panel/img/theming/themes.png and /dev/null differ diff --git a/docs/admin/admin_panel/img/user_details_admin_page.png b/docs/admin/admin_panel/img/user_details_admin_page.png deleted file mode 100644 index b9f5294e6cc..00000000000 Binary files a/docs/admin/admin_panel/img/user_details_admin_page.png and /dev/null differ diff --git a/docs/admin/admin_panel/index.rst b/docs/admin/admin_panel/index.rst deleted file mode 100644 index 48b0df8147d..00000000000 --- a/docs/admin/admin_panel/index.rst +++ /dev/null @@ -1,1197 +0,0 @@ -Accessing the panel -=================== - -| The *Admin Panel* is a model-centric interface where trusted users can manage content on GeoNode. -| Only the staff users can access the admin interface. - -.. note:: The “staff” flag, which controls whether the user is allowed to log in to the admin interface, can be set by the admin panel itself. - -The panel can be reached from :guilabel:`Admin` link of the *User Menu* in the navigation bar (see the picture below) or through this URL: ``http:///admin``. - -.. figure:: img/admin_link.png - :align: center - - *The Admin Link of the User Menu* - -When clicking on that link the Django-based *Admin Interface* page opens and shows you all the Django models registered in GeoNode. - -.. figure:: img/django_geonode_admin_interface.png - :align: center - - *The GeoNode Admin Interface* - -Reset or Change the admin password -================================== - -From the *Admin Interface* you can access the :guilabel:`CHANGE PASSWORD` link on the right side of the navigation bar. - -.. figure:: img/change_password_link.png - :align: center - - *The Change Password Link* - -It allows you to access the *Change Password Form* through which you can change your password. - -.. figure:: img/change_password_form.png - :align: center - - *The Change Password Form* - -Once the fields have been filled out, click on :guilabel:`CHANGE MY PASSWORD` to perform the change. - -.. _simple-theming: - -Simple Theming -============== - -GeoNode provides by default some theming options manageable directly from the Administration panel. -Most of the times those options allows you to easily change the GeoNode look and feel without touching a single line of `HTML` or `CSS`. - -As an `administrator` go to ``http:///admin/geonode_themes/geonodethemecustomization/``. - -.. figure:: img/theming/themes.png - :align: center - - *List of available Themes* - -The panel shows all the available GeoNode themes, if any, and allows you to create new ones. - -.. warning:: Only one theme at a time can be **activated** (aka *enabled*). By disabling or deleting all the available themes, GeoNode will turn the gui back to the default one. - -Editing or creating a new Theme, will actually allow you to customize several properties. - -At least you'll need to provide a ``Name`` for the Theme. Optionally you can specify also a ``Description``, which will allow you to better -identify the type of Theme you created. - -.. figure:: img/theming/theme-def-0001.png - :align: center - - *Theme Name and Description* - -Just below the ``Description`` field, you will find the ``Enabled`` checkbox, allowing you to toggle the Theme. - -.. figure:: img/theming/theme-def-0002.png - :align: center - - *Theme Name and Description* - -Jumbotron and Get Started link -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. note:: Remember, everytime you want to apply some changes to the Theme, you **must** save the Theme and reload the GeoNode browser tab. - In order to quickly switch back to the Home page, you can just click the ``VIEW SITE`` link on the top-right corner of the Admin dashboard. - - .. figure:: img/theming/theme-def-0003c.png - :align: center - -The next section, allows you to define the first important Theme properties. This part involves the GeoNode main page sections. - -.. figure:: img/theming/theme-def-0003.png - :align: center - - *Jumbotron and Logo options* - -By changing those properties as shown above, you will easily change your default home page from this - -.. figure:: img/theming/theme-def-0003a.png - :align: center - - *GeoNode Default Home* - -to this - -.. figure:: img/theming/theme-def-0003b.png - :align: center - - *Updating Jumbotron and Logo* - -It is possible to optionally **hide** the ``Jumbotron text`` and/or the ``Call to action`` button - -.. figure:: img/theming/theme-def-0003d.png - :align: center - -.. figure:: img/theming/theme-def-0003e.png - :align: center - - *Hide Jumbotron text and Call to action button* - -Copyright and contact info footer -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The default GeoNode footer does not present any type of contact info. - -.. figure:: img/theming/theme-def-0004.png - :align: center - - *Default GeoNode Footer* - -By enabling and editing the ``contact us box`` fields - -.. figure:: img/theming/theme-def-0004a.png - :align: center - - *Enable contact us box* - -it will be possible to show a simple *Contact Us* info box on the GeoNode footer section. - -.. figure:: img/theming/theme-def-0004b.png - :align: center - - *Contact Us Footer* - -Similarly, by editing the ``Copyright`` text box and/or background color - -.. figure:: img/theming/theme-def-0004c.png - :align: center - - *Copyright Text and Color* - -it will be possible to show the Copyright statement to the bottom of the page - -.. figure:: img/theming/theme-def-0004d.png - :align: center - - *Copyright* - -Partners -^^^^^^^^ - -GeoNode simple theming, allows also a ``Partners`` section, in order to easily list links to third-party institutions collaborating to the project. - -The example below shows the ``Partners`` section of `WorldBank CHIANG MAI URBAN FLOODING `_ GeoNode instance -made through integrating theming options. - -.. figure:: img/theming/theme-def-0005.png - :align: center - - *Urbanflooding GeoNode Partners Section* - -The ``Partners`` items can be managed through the ``http:///admin/geonode_themes/partner/`` Admin section - -.. figure:: img/theming/theme-def-0005a.png - :align: center - - *GeoNode Partners Admin Section* - -From here it is possible to add, modify or delete partners items. - -A new partner is defined by few elements, a ``Logo``, a ``Name``, a ``Display Name`` and a ``Website`` - -.. figure:: img/theming/theme-def-0005b.png - :align: center - - *Add a Partner* - -In order to attach or detach a ``Partner`` to an existing ``Theme`` on GeoNode, you will need to edit the Theme and go to the ``Partners`` section - -.. figure:: img/theming/theme-def-0005c.png - :align: center - - *Theme Partners Section* - -From here you will be able to either to change the ``Partners title`` text and/or select/deselect ``Partners`` from the ``multi-select`` box. - -.. note:: In order to select/deselect elements from the ``multi-select`` box, you **must** use the ``CTRL+CLICK`` button combintation. - -Privacy Policies and Cookie settings -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -By enabling the ``Cookies Law Info Bar`` checkbox (``True`` by default) - -.. figure:: img/theming/theme-def-0006.png - :align: center - - *Cookies Law Info Bar checkbox* - -it will be possible to allow GeoNode presenting the `Privacy Policies and Cookie settings` pop-ups and links at the bottom of the home page - -.. figure:: img/theming/theme-def-0006a.png - :align: center - - *Cookies Law Info Bar* - -There are plenty of options available, allowing you to customize contact info as long as colors of the bar and page. - -One of the most importat to consider it is for sure the ``Cookie law info bar text`` - -.. figure:: img/theming/theme-def-0006b.png - :align: center - - *Cookie law info bar text* - -The default text contained in this section is the following one - -.. code-block:: html - - This website uses cookies to improve your experience, - check this page for details. - We'll assume you're ok with this, but you can opt-out if you wish. - - -The text can be changed and customized, of course. Nevertheless it points by default to the following page - -.. code-block:: shell - - /privacy_cookies/ - -aka `http:///privacy_cookies/` - -.. figure:: img/theming/theme-def-0006c.png - :align: center - - */privacy_cookies/ Default Page* - -The page contains a default generic text along with some placeholders, which, most probably, won't feet your needs. - -In order to change this you have two options: - -1. Change the link reported into the ``Cookie law info bar text`` section, to make it pointing to an external/static page. - -2. Change the contents of ``/geonode/templates/privacy-cookies.html`` Django template accordingly to your needs; this is basically a plain ``HTML`` page which can be easily customized by using a standard text editor. - -Switching between different themes -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -In the case you have defined more Themes, switching between them is as easy as ``enabling`` one and ``disabling`` the others. - -Remember to save the Themes everytime and refresh the GeoNode home page on the browser to see the changes. - -It is also important that there is **only one** Theme enabled **at a time**. - -In order to go back to the standard GeoNode behavior, just disable or delete all the available Themes. - -Add a new user -============== - -In GeoNode, administrators can manage other users. For example, they can *Add New Users* through the following form. - -.. figure:: img/add_user_form.png - :align: center - - *Adding New Users* - -The form above can be reached from the *Admin Panel* at the following path: *Home > People > Users*. Click on :guilabel:`ADD USER +` to open the form page. - -.. figure:: img/add_user_button.png - :align: center - - *The Add User button in the Users List page* - -It is also available, in the GeoNode UI, the :guilabel:`Add User` link of the *About* menu in the navigation bar. - -.. figure:: img/add_user_link.png - :align: center - - *Add User Link* - -To perform the user creation fill out the required fields (*username* and *password*) and click on :guilabel:`SAVE`. -You will be redirected to the *User Details Page* which allows to insert further information about the user. - -.. figure:: img/user_details_admin_page.png - :align: center - - *The User Details Page* - -The user will be visible into the *Users List Page* of the *Admin Panel* and in the *People Page* (see :ref:`user-info`). - -.. figure:: img/new_user_in_people.png - :align: center - - *The User in the People page* - -Activate/Disable a User -======================= - -When created, new users are *active* by default. -You can check that in the *User Details Page* from the *Admin Panel* (see the picture below). - -.. figure:: img/new_user_active.png - :align: center - - *New Users Active by default* - -| *Active* users can interact with other users and groups, can manage resources and, more in general, can take actions on the GeoNode platform. -| Untick the *Active* checkbox to disable the user. It will be not considered as user by the GeoNode system. - -.. figure:: img/new_user_disabled.png - :align: center - - *Disabeld Users* - -Change a User password -====================== - -GeoNode administrators can also change/reset the password for those users who forget it. -As shown in the picture below, click on ``this form`` link from the *User Details Page* to access the *Change Password Form*. - -.. figure:: img/change_user_password_link.png - :align: center - - *Changing Users Passwords* - -The *Change User Password Form* should looks like the following one. -Insert the new password two times and click on :guilabel:`CHANGE PASSWORD`. - -.. figure:: img/chenge_user_password_form.png - :align: center - - *Changing Users Passwords* - -Promoting a User to Staff member or superuser -============================================= - -Active users have not access to admin tools. -GeoNode makes available those tools only to *Staff Members* who have the needed permissions. -*Superusers* are staff members with full access to admin tools (all permissions are assigned to them). - -Administrators can promote a user to *Staff Member* by ticking the **Staff status** checkbox in the *User Details Page*. -To make some user a *Superuser*, the **Superuser status** checkbox should be ticked. See the picture below. - -.. figure:: img/staff_and_superuser_permissions.png - :align: center - - *Staff and Superuser permissions* - -Creating a Group -================ - -| In GeoNode is possible to create new groups with set of permissions which will be inherited by all the group members. -| The creation of a Group can be done both on the GeoNode UI and on the *Admin Panel*, we will explain how in this paragraph. - -The :guilabel:`Create Groups` link of *About* menu in the navigation bar allows administrators to reach the *Group Creation Page*. - -.. figure:: img/create_group_page_link.png - :align: center - - *The Create Group Link* - -The following form will open. - -.. figure:: img/group_creation_form.png - :align: center - - *The Group Creation Form* - -Fill out all the required fields and click :guilabel:`Create` to create the group. -The *Group Details Page* will open. - -.. figure:: img/group_details_page.png - :align: center - - *The Group Details Page* - -The new created group will be searchable in the *Groups List Page*. - -.. figure:: img/groups_list_page.png - :align: center - - *The Groups List Page* - -.. note:: The :guilabel:`Create a New Group` button on the *Groups List Page* allows to reach the *Group Creation Form*. - -| As already mentioned above, groups can also be created from the Django-based *Admin Interface* of GeoNode. -| The *Groups* link of the *AUTHENTICATION AND AUTHORIZATION* section allows to manage basic Django groups which only care about permissions. -| To create a GeoNode group you should take a look at the *GROUPS* section. - -.. figure:: img/groups_admin_section.png - :align: center - - *The Groups Section on the Admin Panel* - -As you can see, GeoNode provides two types of groups. You will learn more about that in the next paragraph. - -Types of Groups -^^^^^^^^^^^^^^^ - -In GeoNode users can be grouped through a *Group Profile*, an enhanced Django group which can be enriched with some further information such as a description, a logo, an email address, some keywords, etc. -It also possible to define some *Group Categories* based on which those group profiles can be divided and filtered. - -A new **Group Profile** can be created as follow: - -* click on the *Group Profile* :guilabel:`+ Add` button - -* fill out all the required fields (see the picture below), *Group Profiles* can be explicitly related to group categories - - .. figure:: img/new_group_profile_form.png - :align: center - - *A new Group Profile* - -* click on :guilabel:`SAVE` to perform the creation, the new created group profile will be visible in the *Group Profiles List* - - .. figure:: img/group_profiles_list.png - :align: center - - *The Group Profiles List* - -Group Categories -^^^^^^^^^^^^^^^^ - -*Group Profiles* can also be related to *Group Categories* which represents common topics between groups. -In order to add a new **Group Category** follow these steps: - -* click on the *Group Categories* :guilabel:`+ Add` button - -* fill out the creation form (type *name* and *description*) - - .. figure:: img/new_group_category_form.png - :align: center - - *A new Group Category* - -* click on :guilabel:`SAVE` to perform the creation, the new created category will be visible in the *Group Categories List* - - .. figure:: img/group_categories_list.png - :align: center - - *The Group Categories List* - -| When a GeoNode resource (layer, document or maps) is associated to some *Group Profile*, it is also possible to retrieve the *Group Category* it belongs to. -| So when searching for resources (see :ref:`finding-data`) you can also filter the data by group category. - -.. figure:: img/layers_group_category.png - :align: center - - *Filtering Layers by Group Category* - -Managing a Group -================ - -Through the :guilabel:`Groups` link of *About* menu in the navigation bar, administrators can reach the *Groups List Page*. - -.. figure:: img/groups_link.png - :align: center - - *The Groups Link in the navigation bar* - -In that page all the GeoNode *Group Profiles* are listed. - -.. figure:: img/group_profiles_list_page.png - :align: center - - *Group Profiles List Page* - -For each group some summary information (such as the *title*, the *description*, the number of *members* and *managers*) are displayed near the *Group Logo*. - -Administrators can manage a group from the *Group Profile Details Page* which is reachable by clicking on the *title* of the group. - -.. figure:: img/group_profile_details_page.png - :align: center - - *Group Profile Details Page* - -As shown in the picture above, all information about the group are available on that page: - -* the group *Title*; -* the *Last Editing Date* which shows a timestamp corresponding to the last editing of the group properties; -* the *Keywords* associated with the group; -* *Permissions* on the group (Public, Public(invite-only), Private); -* *Members* who join the group; -* *Managers* who manage the group. - -There are also four links: - -* The :guilabel:`Edit Group Details` link opens the *Group Profile Form* through which the following properties can be changed: - - * *Title*. - * *Logo* (see next paragraphs). - * *Description*. - * *Email*, to contact one or all group members. - * *Keywords*, a comma-separated list of keywords. - * *Access*, which regulates permissions: - - * *Public*: any registered user can view and join a public group. - * *Public (invite-only)*: only invited users can join, any registered user can view the group. - * *Private*: only invited users can join the group, registered users cannot see any details about the group, including membership. - - * *Categories*, the group categories the group belongs to. - - .. figure:: img/group_profile_details_page.png - :align: center - - *Group Profile Details Page* - -* :guilabel:`Managing Group Members` (see next paragraphs). -* the :guilabel:`Delete this Group`, click on it to delete the Group Profile. GeoNode requires you to confirm this action. - - .. figure:: img/confirm_group_deletion.png - :align: center - :width: 400px - - *Confirm Group Deletion* - -* the :guilabel:`Group Activities` drives you to the *Group Activites Page* where you can see all layers, maps and documents associated with the group. There is also a *Comments* tab which shows comments on those resources. - - .. figure:: img/group_activities.png - :align: center - - *Group Activities* - -Group Logo -^^^^^^^^^^ - -Each group represents something in common between its members. -So each group should have a *Logo* which graphically represents the idea that identify the group. - -On the *Group Profile Form* page you can insert a logo from your disk by click on :guilabel:`Browse...`. - -.. figure:: img/editing_group_logo.png - :align: center - - *Editing the Group Logo* - -| Click on :guilabel:`Update` to apply the changes. -| Take a look at your group now, you should be able to see that logo. - -.. figure:: img/group_logo.png - :align: center - - *The Group Logo* - -Managing Group members -^^^^^^^^^^^^^^^^^^^^^^ - -The :guilabel:`Manage Group Members` link opens the *Group Members Page* which shows *Group Members* and *Group Managers*. -**Managers** can edit group details, can delete the group, can see the group activities and can manage memberships. -Other **Members** can only see the group activities. - -| In Public Groups, users can join the group without any approval. - Other types of groups require the user to be invited by the group managers. -| Only group managers can *Add new members*. - In the picture below, you can see the manager can search for users by typing their names into the *User Identifiers* search bar. - Once found, he can add them to the group by clicking the :guilabel:`Add Group Members` button. - The *Assign manager role* flag implies that all the users found will become managers of the group. - -.. figure:: img/add_new_member.png - :align: center - - *Adding a new Member to the Group* - -The following picture shows you the results. - -.. figure:: img/new_members.png - :align: center - - *New Members of the Group* - -Group based advanced data workflow -================================== - -By default GeoNode is configured to make every resource (Layer, Document or Map) suddenly available to everyone, i.e. publicly accessible -even from anonymous/non-logged in users. - -It is actually possible to change few configuration settings in order to allow GeoNode to enable an advanced publication workflow. - -With the advanced workflow enabled, your layer, document or map won't be automatically published (i.e. made visible and accessible for all, contributors or simple users). - -For now, your item is only visible by yourself, the manager of the group to which the layer, document or map is linked (this information is filled in the metadata), the members of this group, and the GeoNode Administrators. - -Before being published, the layer, document or map will follow a two-stage review process, which is described below: - -.. figure:: img/adv_data_workflow/adv_data_workflow_001.jpg - :align: center - - *From upload to publication: the review process on GeoNode* - -How to enable the advanced workflow -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -You have to tweak the GeoNode settings accordingly. - -Please see the details of the following GeoNode ``Settings``: - -* `ADMIN_MODERATE_UPLOADS <../../basic/settings/index.html#admin-moderate-uploads>`_ - -* `GROUP_PRIVATE_RESOURCES <../../basic/settings/index.html#group-private-resources>`_ - -* `RESOURCE_PUBLISHING <../../basic/settings/index.html#resource-publishing>`_ - -The group Manager approval -^^^^^^^^^^^^^^^^^^^^^^^^^^ -Here, the role of the Manager of the group to which your layer, document or map is linked is to check that the uploaded item is correct. -Particularly, in the case of a layer or a map, it consists of checking that the chosen cartographic representation and the style are -fitting but also that the discretization is appropriate. - -The Manager must also check that the metadata are properly completed and that the mandatory information -(Title, Abstract, Edition, Keywords, Category, Group, Region) are filled. - -If needed, the Manager can contact the contributor responsible of the layer, document or map in order to report potential comments or -request clarifications. - -Members of the group can also take part in the reviewing process and give some potential inputs to the responsible of the -layer, document or map. - -When the Manager considers that the layer, document or map is ready to be published, he should approve it. -To do so, the Manager goes to the layer, document or map page, then opens the :guilabel:`Wizard` in order to edit the metadata. -In the :guilabel:`Settings` tab, the manager checks the :guilabel:`Approved` box, and then updates the metadata and saves the changes: - -.. figure:: img/adv_data_workflow/approbation_manager.gif - :align: center - - *The approbation process of an item by a Manager* - -Following this approval, the GeoNode Administrators receive a notification informing them that an item is now waiting for publication - -.. figure:: img/adv_data_workflow/unpublished.png - :align: center - - *An approved layer, waiting for publication by the GeoNode administrators* - -The publication by the GeoNode Administrator -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Prior to the public release of an approved layer, a document or a map, the Administrator of the platform performs a final validation of -the item and its metadata, notably to check that it is in line with licence policies. - -If needed, the GeoNode Administrator can contact the Manager who has approved the layer, document or map, as well as its responsible. - -Once the layer, document or map is validated, the item is made public by the Administrator. -It can now be viewed, accessed, and downloaded in accordance with the ``Permissions`` set by the responsible contributor. - -Manage profiles using the admin panel -===================================== - -So far GeoNode implements two distinct roles, that can be assigned to resources such as layers, maps or documents: - -* party who authored the resource -* party who can be contacted for acquiring knowledge about or acquisition of the resource - -These two profiles can be set in the GeoNode interface by accessing the metadata page and setting the ``Point of Contact`` and ``Metadata Author`` fields respectively. - -Is possible for an administrator to add new roles if needed, by clicking on the :guilabel:`Add Role` button in the :guilabel:`Base -> Contact Roles` section: - -.. figure:: img/admin-roles-add.png - :align: center - -Clicking on the :guilabel:`People` section (see figure) will open a web for with some personal information plus a section called :guilabel:`Users`. - -.. figure:: img/admin-people.png - -Is important that this last section is not modified here unless the administrator is very confident in that operation. - -.. figure:: img/admin-profiles-contactroles.png - :align: center - -Manage layers using the admin panel -=================================== - -Some of the Layers information can be edited directly through the admin interface although the best place is in the :guilabel:`Layer -> Metadata Edit` in GeoNode. - -Clicking on the :guilabel:`Admin > Layers` link will show the list of available layers. - -.. figure:: img/admin-layers.png - :align: center - -.. warning:: It is not recommended to modify the Layers' ``Attributes`` or ``Styles`` directly from the Admin dashboard unless you are aware of your actions. - -The ``Metadata`` information can be changed for multiple Layers at once throguh the :guilabel:`Metadata batch edit` action. - -.. figure:: img/admin-layers-batch.png - :align: center - -By clicking over one Layer link, it will show a detail page allowing you to modify some of the resource info like the metadata, the keywords, the title, etc. - -.. note:: It is strongly recommended to always use the GeoNode :guilabel:`Metadata Wizard` or :guilabel:`Metadata Advanced` tools in order to edit the metadata info. - -The ``Permissions`` can be changed also for multiple Layers at once throguh the :guilabel:`Set layers permissions` action. - -.. figure:: img/set_layers_permissions_action.png - :align: center - -By clicking over one Layer link, it will show a detail page allowing you to modify the permissions for the selected resources. - -.. figure:: img/set_layers_permissions_form.png - :align: center - -Manage the maps using the admin panel -===================================== - -Similarly to the Layers, it is possible to manage the available GeoNode Maps through the Admin panel also. - -Move to :guilabel:`Admin > Maps` to access the Maps list. - -.. figure:: img/admin-maps.png - :align: center - -The ``Metadata`` information can be changed for multiple Maps at once throguh the :guilabel:`Metadata batch edit` action. - -.. figure:: img/admin-layers-batch.png - :align: center - -By clicking over one Map link, it will show a detail page allowing you to modify some of the resource info like the metadata, the keywords, the title, etc. - -.. note:: It is strongly recommended to always use the GeoNode :guilabel:`Metadata Wizard` or :guilabel:`Metadata Advanced` tools in order to edit the metadata info. - -Notice that by enabling the ``Featured`` option here, will allow GeoNode to show the Map thumbnail and the Map detail link on the :guilabel:`Home Page` - -.. figure:: img/admin-maps-featured-001.png - :align: center - -.. figure:: img/admin-maps-featured-002.png - :align: center - -Manage the documents using the admin panel -========================================== - -Similarly to the Layers and Maps, it is possible to manage the available GeoNode Documents through the Admin panel also. - -Move to :guilabel:`Admin > Documents` to access the Documents list. - -.. figure:: img/admin-documents.png - :align: center - -The ``Metadata`` information can be changed for multiple Documents at once throguh the :guilabel:`Metadata batch edit` action. - -.. figure:: img/admin-layers-batch.png - :align: center - -By clicking over one Document link, it will show a detail page allowing you to modify some of the resource info like the metadata, the keywords, the title, etc. - -.. note:: It is strongly recommended to always use the GeoNode :guilabel:`Metadata Wizard` or :guilabel:`Metadata Advanced` tools in order to edit the metadata info. - -Manage the base metadata choices using the admin panel -====================================================== - -:guilabel:`Admin > Base` contains almost all the objects you need to populate the resources metadata choices. - -.. figure:: img/metadata-base/admin-panel-metadata-contents-0001.png - :align: center - - *Admin dashboard Base Panel* - -In other words the options available from the :guilabel:`select-boxes` of the :guilabel:`Metadata Wizard` and :guilabel:`Metadata Advanced` panels. - -.. figure:: img/metadata-base/admin-panel-metadata-contents-0002.png - :align: center - - *Metadata Wizard Panel* - -.. figure:: img/metadata-base/admin-panel-metadata-contents-0003.png - :align: center - - *Metadata Advanced Panel* - -.. note:: When editing the resource metadata throguh the :guilabel:`Metadata Wizard`, some fields are marked as ``mandatory`` and by filling those information - the ``Completeness`` progress will advance accordingly. - - .. figure:: img/metadata-base/admin-panel-metadata-contents-0003a.png - :align: center - - *Metadata Completeness* - - Even if not all the fields have been filled, the system won't prevent you to update the metadata; this is why the ``Mandatory`` fields are - mandatory to be fully compliant with an ``ISO 19115`` metadata schema, but are only recommended to be compliant with GeoNode. - - Also the ``Completeness`` indicates how far the metadata is to be compliant with an ``ISO 19115`` metadata schema. - - Of course, it is **highly** recommended to always fill as much as possible at least all the metadata fields marked as ``Mandatory``. - - This will improve not only the quality of the data stored into the system, but will help the users to easily search for them on GeoNode. - - All the ``Search & Filter`` panels and options of GeoNode are, in fact, based on the resources metadata fields. Too much generic descriptions and - too empty metadata fields, will give highly un-precise and very wide search results to the users. - -Hierarchical keywords -^^^^^^^^^^^^^^^^^^^^^ - -Through the :guilabel:`Admin > Base > Hierarchical keywords` panel it will be possible to manage all the keywords associated to the resources. - -.. figure:: img/metadata-base/admin-panel-metadata-contents-0004.png - :align: center - - *Hierarchical keywords list* - -.. figure:: img/metadata-base/admin-panel-metadata-contents-0005.png - :align: center - - *Hierarchical keywords edit* - -* The :guilabel:`Name` is the human readable text of the keyword, what users will see. - -* The :guilabel:`Slug` is a unique label used by the system to identify the keyword; most of the times it is equal to the name. - -Notice that through the :guilabel:`Position` and :guilabel:`Relative to` selectors, it is possible to establish a hierarchy between the available keywords. - -By default each user with editing metadata rights on any resource, will be able to insert new keywords into the system by simply typing a free text on the keywords metadata field. - -It is possible to force the user to select from a fixed list of keywords throug the `FREETEXT_KEYWORDS_READONLY <../../basic/settings/index.html#freetext-keywords-readonly>`_ setting. - -When set to `True` keywords won't be writable from users anymore. Only admins can will be able to manage them through the :guilabel:`Admin > Base > Hierarchical keywords` panel. - -Licenses -^^^^^^^^ - -Through the :guilabel:`Admin > Base > Licenses` panel it will be possible to manage all the licenses associated to the resources. - -.. figure:: img/metadata-base/admin-panel-metadata-contents-0006.png - :align: center - - *Metadata editor Licenses* - -The licence description and the info URL will be shown on the resource detail page. - -.. figure:: img/metadata-base/admin-panel-metadata-contents-0007.png - :align: center - - *Resource detail License* - -The licence text will be shown on the catalogue metadata XML documents. - -.. figure:: img/metadata-base/admin-panel-metadata-contents-0008.png - :align: center - - *Resource Metadata ISO License* - -.. warning:: It is **strongly** recommended to not publish resources without an appropriate licence. Always make sure the data provider specifies the correct licence and that all the restrictions have been honored. - -Metadata Regions -^^^^^^^^^^^^^^^^ - -Through the :guilabel:`Admin > Base > Metadata Regions` panel it will be possible to manage all the admin areas associated to the resources. - -.. figure:: img/metadata-base/admin-panel-metadata-contents-0009.png - :align: center - - *Resource Metadata Regions* - -Notice that those regions are used by GeoNode to filter search results also through the resource list view. - -.. figure:: img/metadata-base/admin-panel-metadata-contents-0010.png - :align: center - - *GeoNode fitlering by Metadata Regions* - -.. note:: GeoNode tries to guess the ``Regions`` intersecting the data bounding boxes when uploading a new layer. Those should be refined by the user layer on anyway. - -Metadata Restriction Code Types and Spatial Representation Types -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Through the :guilabel:`Admin > Base > Metadata Restriction Code Types` and :guilabel:`Admin > Base > Metadata Spatial Representation Types` panels, it will -be possible to **update only** the metadata descriptions for restrictions and spatial representation types. - -Such lists are *read-only* by default since they have been associated to the specific codes of the ``ISO 19115`` metadata schema. -Changing them would require the system to provide a custom dictionary throguh the metadata catalog too. Such functionality is not supported actually by GeoNode. - -Metadata Topic Categories -^^^^^^^^^^^^^^^^^^^^^^^^^ - -Through the :guilabel:`Admin > Base > Metadata Topic Categories` panel it will be possible to manage all the resource metadata categories avaialble into the system. - -Notice that by default, GeoNode provides the standard topic categories avaialble with the ``ISO 19115`` metadata schema. Changing them means that the system won't be -compliant with the standard ``ISO 19115`` metadata schema anymore. ``ISO 19115`` metadata schema extensions are not currently supported natively by GeoNode. - -It is worth notice that GeoNode allows you to associate `Font Awesome Icons `_ to each topic category through their ``fa-icon`` code. -Those icons will be used by GeoNode to represent the topic category on both the ``Search & Filter`` menus and :guilabel:`Metadata` panels. - -.. warning:: The list of the ``Metadata Topic Categories`` on the home page is currently fixed. To change it you will need to update or override the GeoNode ``index.html`` HTML template. - -By default the ``Metadata Topic Categories`` are *writable*. Meaning that they can be removed or created by the :guilabel:`Admin` panel. - -It is possible to make them fixed (it will be possible to update their descriptions and icons only) through the `MODIFY_TOPICCATEGORY <../../basic/settings/index.html#modify-topiccategory>`_ setting. - -Announcements -============= - -As an Administrator you might need to broadcast announcements to the world about your portal or simply to the internal contributors. - -GeoNode ``Announcements`` allow actually to do that; an admin has the possibility to create thre types of messages, accordingly to their severity, -decide their validity in terms of time period (start date and expiring date of the announcement), who can view them or not (everyone or just the -registerd members) and whenever a user can hide the message or not and how long. - -A GeoNode announcement actually looks like this: - -.. figure:: img/announcments/admin-announcments-001.png - :align: center - - *A sample Warning Announcement* - -There are three types of announcements accordingly to their severity level: ``General``, ``Warning`` and ``Critical`` -The difference is mainly the color of the announcement box. - -.. figure:: img/announcments/admin-announcments-002.png - :align: center - - *General Announcement* - -.. figure:: img/announcments/admin-announcments-003.png - :align: center - - *Warning Announcement* - -.. figure:: img/announcments/admin-announcments-004.png - :align: center - - *Critical Announcement* - -Only administrators and staff members can create and manage announcements. - -Currently there two ways to access and manage the announcements list: - -#. Via the GeoNode interface, from the :guilabel:`Profile` panel - - .. note:: Those are accessible by both admins and staff members. - - .. figure:: img/announcments/admin-announcments-005.png - :align: center - - *Announcements from the Profile panel* - -#. Via the GeoNode :guilabel:`Admin` panel - - .. note:: Those are accessible by admins only. - - .. figure:: img/announcments/admin-announcments-006.png - :align: center - - *Announcements from the Admin panel* - -The functionalities are almost the same for both the interfaces, except that from the :guilabel:`Admin` panel it is possible to manage the -dismissals too. - -``Dismissals`` are basically records of members that have read the announcement and closed the message box. An announcement can have one -``dismissal type`` among the three below: - -#. :guilabel:`No Dismissal Allowed` it won't be possible to close the announcement's message box at all. - -#. :guilabel:`Session Only Dismissal` (*) the default one, it will be possible to close the announcement's message box for the current browser session. It will show up again at next access. - -#. :guilabel:`Permanent Dismissal Allowed` once the announcement's message box is closed, it won't appear again for the current member. - -How to create and manage Announcements -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -From the :guilabel:`Profile` panel, click on ``Announcements`` link - -.. figure:: img/announcments/admin-announcments-007.png - :align: center - - *Announcements List from the Profile panel* - -Click either on :guilabel:`New Announcement` to create a new one or over a title of an existing one to manage its contents. - -Create a new announcement is quite straight; you have to fill the fields provided by the form. - -.. warning:: In order to be visible, you will need to check the :guilabel:`Site wide` option **in any case**. You might want to hide the message to *anonymous* users by enabling the :guilabel:`Members only` option too. - -.. figure:: img/announcments/admin-announcments-008.png - :align: center - - *Create Announcement from the Profile panel* - -Managing announcements form the :guilabel:`Admin` panel, is basically the same; the fields for the form will be exactly the same. - -.. figure:: img/announcments/admin-announcments-009.png - :align: center - - *Create Announcement from the Admin panel* - -Accessing announcements options from the :guilabel:`Admin` panel, allows you to manage dismissals also. -Through this interface you will be able to selectively decide members which can or cannot view a specific announcement, or force them to visualize the messages again by deleting the dismissals accordingly. - -.. figure:: img/announcments/admin-announcments-010.png - :align: center - - *Create Dismissal from the Admin panel* - -Menus, Items and Placeholders -============================= - -GeoNode provides some integrated functionalities allowing you to quickly and easily customize the top-bar menu (see the example below). - -.. figure:: img/admin-panel-menus-0000.png - :align: center - - *GeoNode Top-Bar Menu customization* - -With minor changes of the ``basic.html`` template, potentially, it could be possible to use the same approach for a more complex customization. -Let's start with the simple one. - -By default GeoNode provides a custom ``placeholder`` already defined into the ``basic.html`` template, called ``TOPBAR_MENU`` - -.. code-block:: python - - ... -
    - - {% block my_extra_right_tab %} - - {% render_nav_menu 'TOPBAR_MENU' %} - - {% endblock my_extra_right_tab %} - -
  • -
    - -
    -
    • - ... - -From the :guilabel:`Admin > Base` panel, it is possible to access to the ``Menu``, ``Menu Items`` and ``Menu Placeholder`` options. - -.. figure:: img/admin-panel-menus-0001.png - :align: center - - *Menu, Menu Items and Menu Placeholder options on the Admin panel* - -The hierarchical structure of a custom ``Menu`` is the following one: - -1. ``Menu Placeholder``; first of all you need to define a *placeholder* both into the :guilabel:`Admin > Base` panel and the ``basic.html`` template, using the same **keyword**. - By default GeoNode provides an already defined one called ``TOPBAR_MENU`` - - .. figure:: img/admin-panel-menus-0002.png - :align: center - - *The default ``TOPBAR_MENU`` Menu Placeholder on the Admin panel* - -2. ``Menu``; second thing to do is to create a new *menu* associated to the corresponding *placeholder*. - This is still possible from the :guilabel:`Admin > Base` panel - - .. figure:: img/admin-panel-menus-0003.png - :align: center - - *Create a new Menu from the Admin panel* - - You will need to provide: - - * A ``Title``, representing the name of the ``Menu`` visible by the users - - .. warning:: By using this approach, internationalization won't be supported. For the time being GeoNode does not support this for menus created from the :guilabel:`Admin > Base` panel. - - * A ``Menu Placeholder`` from the existing ones. - - * A ``Order`` in the case you'll create more menus associated to the same placeholder. - -3. ``Menu Item``; finally you will need to create voices belonging to the *menu*. For the time being, GeoNode allows you to create only ``href`` links. - - .. figure:: img/admin-panel-menus-0004.png - :align: center - - *Create a new Menu Item from the Admin panel* - - .. warning:: The ``Menu`` won't be visible until you add at least one ``Menu Item`` - -.. _oauth2_admin_panel_access_tokens: - -OAuth2 Access Tokens -==================== - -This small section won't cover entirely the GeoNode OAuth2 security integration, this is explained in detail in other sections of the documentation -(refer to :ref:`oauth2_fixtures_and_migration` and :ref:`oauth2_tokens_and_sessions`). - -Here we will focus mainly on the :guilabel:`Admin > DJANGO/GEONODE OAUTH TOOLKIT` panel items with a specific attention to the ``Access tokens`` management. - -The :guilabel:`Admin > DJANGO/GEONODE OAUTH TOOLKIT` panel (as shown in the figure below) allows an admin to manage everything related to -GeoNode OAuth2 grants and permissions. - -As better explained in other sections of the documentation, this is needed to correctly handle the communication between GeoNode and GeoServer. - -.. figure:: img/oauth2-tokens/admin-panel-tokens-0001.png - :align: center - - *DJANGO/GEONODE OAUTH TOOLKIT Admin panel* - -Specifically from this panel an admin can create, delete or extend OAuth2 ``Access tokens``. - -The section :ref:`oauth2_tokens_and_sessions` better explains the concepts behind OAuth2 sessions; we want just to refresh the mind here -about the basic concepts: - -* If the `SESSION_EXPIRED_CONTROL_ENABLED <../../basic/settings/index.html#session-expired-control-enabled>`_ setting is set to `True` (by default it is set to `True`) - a registered user cannot login to neither GeoNode nor GeoServer without a valid ``Access token``. - -* When logging-in into GeoNode through the sign-up form, GeoNode checks if a valid ``Access token`` exists and it creates a new one if not, or extends - the existing one if expired. - -* New ``Access tokens`` expire automatically after `ACCESS_TOKEN_EXPIRE_SECONDS <../../basic/settings/index.html#access-token-expire-seconds>`_ setting (by default 86400) - -* When an ``Access token`` expires, the user will be kicked out from the session and forced to login again - -Create a new token or extend an existing one -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -It is possible from the :guilabel:`Admin > DJANGO/GEONODE OAUTH TOOLKIT` panel to create a new ``Access token`` for a user. - -In order to do that, just click on the :guilabel:`Add` button beside ``Access tokens`` topic - -.. figure:: img/oauth2-tokens/admin-panel-tokens-0002.png - :align: center - - *Add a new ``Access token``* - -On the new form - -.. figure:: img/oauth2-tokens/admin-panel-tokens-0003.png - :align: center - - *Create an ``Access token``* - -select the followings: - -1. ``User``; use the search tool in order to select the correct user. The form want the user PK, which is a number, and **not** the username. - The search tool will do everything for you. - - .. figure:: img/oauth2-tokens/admin-panel-tokens-0003a.png - :align: center - - *Select a User* - -2. ``Source refresh token``; this is not mandatory, leave it blank. - -3. ``Token``; write here any alphanumeric string. This will be the ``access_token`` that the member can use to access the OWS services. - We suggest to use a service like https://passwordsgenerator.net/ in order to generate a strong token string. - - .. figure:: img/oauth2-tokens/admin-panel-tokens-0003b.png - :align: center - - *Select a Token* - -4. ``Application``; select **GeoServer**, this is mandatory - - .. figure:: img/oauth2-tokens/admin-panel-tokens-0003c.png - :align: center - - *Select the GeoServer Application* - -5. ``Expires``; select an expiration date by uwing the :guilabel:`date-time` widgets. - - .. figure:: img/oauth2-tokens/admin-panel-tokens-0003d.png - :align: center - - *Select the Token Expiration* - -6. ``Scope``; select **write**, this is mandatory. - - .. figure:: img/oauth2-tokens/admin-panel-tokens-0003e.png - :align: center - - *Select the Application Scope* - -Do not forget to :guilabel:`Save`. - -From now on, GeoNode will use this ``Access Token`` to control the user session (notice that the user need to login again if closing the browser session), -and the user will be able to access the OWS Services by using the new ``Access Token``, e.g.: - -.. code-block:: shell - - https://dev.geonode.geo-solutions.it/geoserver/ows?service=wms&version=1.3.0&request=GetCapabilities&access_token=123456 - - -Notice the ``...quest=GetCapabilities&access_token=123456`` (**access_token**) parameter at the end of the URL. - -Force a User Session to expire -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Everyting said about the creation of a new ``Access Token``, applies to the deletion of the latter. - -From the same interface an admin can either select an expiration date or delete all the ``Access Tokens`` associated to a user, in order to -force its session to expire. - -Remember that the user could activate another session by logging-in again on GeoNode with its credentials. - -In order to be sure the user won't force GeoNode to refresh the token, reset first its password or de-activate it. \ No newline at end of file diff --git a/docs/admin/async/index.rst b/docs/admin/async/index.rst deleted file mode 100644 index 549c0800956..00000000000 --- a/docs/admin/async/index.rst +++ /dev/null @@ -1,8 +0,0 @@ -Supervisord and Systemd -======================= - -Celery -====== - -Rabbitmq and Redis -================== diff --git a/docs/admin/default_lang/index.rst b/docs/admin/default_lang/index.rst deleted file mode 100644 index 35ba470dacb..00000000000 --- a/docs/admin/default_lang/index.rst +++ /dev/null @@ -1,80 +0,0 @@ -.. _default_language: - -Changing the Default Language -============================= - -GeoNode's default language is English, but GeoNode users can change the interface language with the pulldown menu at the top-right of most GeoNode pages. Once a user selects a language GeoNode remembers that language for subsequent pages. - -GeoNode Configuration -===================== - -As root edit the geonode config file :file:`/home/geonode/geonode/geonode/settings.py` (or :file:`/etc/geonode/settings.py` if GeoNode has been installed using **apt-get**) and change ``LANGUAGE_CODE`` to the desired default language. - -.. note:: A list of language codes can be found in the global django config file :file:`/usr/local/lib/python2.7/dist-packages/django/conf/global_settings.py` (or :file:`/var/lib/geonode/lib/python2.7/site-packages/django/conf/global_settings.py` if GeoNode has been installed using **apt-get**). - -For example, to make French the default language use:: - - LANGUAGE_CODE = 'fr' - -Unfortunately Django overrides this setting, giving the language setting of a user's browser priority. For example, if ``LANGUAGE_CODE`` is set to French, but the user has configured their operating system for Spanish they may see the Spanish version when they first visit GeoNode. - - -Additional Steps -================ - -If this is not the desired behaviour, and all users should initially see the default ``LANGUAGE_CODE``, regardless of their browser's settings, do the following steps to ensure Django ignores the browser language settings. (Users can always use the pulldown language menu to change the language at any time.) - -As **root** create a new directory within GeoNode's site packages - -.. code-block:: shell - - mkdir /usr/lib/python2.7/dist-packages/setmydefaultlanguage - -or - -.. code-block:: shell - - mkdir /var/lib/geonode/lib/python2.7/site-packages/setmydefaultlanguage - -if GeoNode has been installed using **apt-get**. - -As root create and edit a new file :file:`/usr/lib/python2.7/dist-packages/setmydefaultlanguage/__init__.py` and add the following lines - -.. code-block:: python - - class ForceDefaultLanguageMiddleware(object): - """ - Ignore Accept-Language HTTP headers - - This will force the I18N machinery to always choose settings.LANGUAGE_CODE - as the default initial language, unless another one is set via sessions or cookies - - Should be installed *before* any middleware that checks request.META['HTTP_ACCEPT_LANGUAGE'], - namely django.middleware.locale.LocaleMiddleware - """ - def process_request(self, request): - if request.META.has_key('HTTP_ACCEPT_LANGUAGE'): - del request.META['HTTP_ACCEPT_LANGUAGE'] - -At the end of the GeoNode configuration file :file:`/home/geonode/geonode/geonode/settings.py` (or :file:`/etc/geonode/settings.py` if GeoNode has been installed using **apt-get**) add the following lines to ensure the above class is executed - -.. code-block:: python - - MIDDLEWARE_CLASSES += ( - 'setmydefaultlanguage.ForceDefaultLanguageMiddleware', - ) - -Restart -======= - -You will need to restart GeoNode accordingly to the installation method you have choosen. - -As an instance in case you are using `NGINX` with `UWSGI`, as root you will need to run the following commands - -.. code-block:: shell - - service uwsgi restart - service nginx restart - - -Please refer to Translating GeoNode for information on editing GeoNode pages in different languages and create new GeoNode Translations. \ No newline at end of file diff --git a/docs/admin/index.rst b/docs/admin/index.rst deleted file mode 100644 index c3961ab9169..00000000000 --- a/docs/admin/index.rst +++ /dev/null @@ -1,58 +0,0 @@ -GeoNode Admins Guide -==================== - -GeoNode has an administration panel, based on the Django admin, which can be used to do some database operations. -Although most of the operations can and should be done through the normal GeoNode interface, -the admin panel provides a quick overview and management tool over the database. - -The following sections will explain more in depth what functionalities the admin panel makes you available. -It should be highlighted that the sections not covered in this guide are meant to be managed through GeoNode UI. - -.. toctree:: - :maxdepth: 3 - - admin_panel/index - -GeoNode Management Commands -=========================== - -.. toctree:: - :caption: GeoNode Management Commands - :maxdepth: 3 - - mgmt_commands/index - -Changing the default Languages -============================== - -.. toctree:: - :caption: Changing the default Languages - :maxdepth: 3 - - default_lang/index - -GeoNode Upgrade from older versions -=================================== - -.. toctree:: - :caption: GeoNode Upgrade from older versions - :maxdepth: 3 - - upgrade/index - -GeoNode Async Signals -===================== - -.. toctree:: - :caption: GeoNode Async Signals - :maxdepth: 3 - - async/index - -GeoNode add a thesaurus -======================= - -.. toctree:: - :maxdepth: 3 - - thesaurus/index diff --git a/docs/admin/mgmt_commands/img/add_test_user.png b/docs/admin/mgmt_commands/img/add_test_user.png deleted file mode 100644 index cf1a709b704..00000000000 Binary files a/docs/admin/mgmt_commands/img/add_test_user.png and /dev/null differ diff --git a/docs/admin/mgmt_commands/img/add_user.png b/docs/admin/mgmt_commands/img/add_user.png deleted file mode 100644 index 4cef004926f..00000000000 Binary files a/docs/admin/mgmt_commands/img/add_user.png and /dev/null differ diff --git a/docs/admin/mgmt_commands/img/admin_interface.png b/docs/admin/mgmt_commands/img/admin_interface.png deleted file mode 100644 index 93917ea1847..00000000000 Binary files a/docs/admin/mgmt_commands/img/admin_interface.png and /dev/null differ diff --git a/docs/admin/mgmt_commands/img/geoserver_admin.png b/docs/admin/mgmt_commands/img/geoserver_admin.png deleted file mode 100644 index 0b7e90a5484..00000000000 Binary files a/docs/admin/mgmt_commands/img/geoserver_admin.png and /dev/null differ diff --git a/docs/admin/mgmt_commands/img/geoserver_layer_params.png b/docs/admin/mgmt_commands/img/geoserver_layer_params.png deleted file mode 100644 index 7efad1004b5..00000000000 Binary files a/docs/admin/mgmt_commands/img/geoserver_layer_params.png and /dev/null differ diff --git a/docs/admin/mgmt_commands/img/geoserver_layers.png b/docs/admin/mgmt_commands/img/geoserver_layers.png deleted file mode 100644 index f1a15b66013..00000000000 Binary files a/docs/admin/mgmt_commands/img/geoserver_layers.png and /dev/null differ diff --git a/docs/admin/mgmt_commands/img/geoserver_new_store.png b/docs/admin/mgmt_commands/img/geoserver_new_store.png deleted file mode 100644 index dca47e2649f..00000000000 Binary files a/docs/admin/mgmt_commands/img/geoserver_new_store.png and /dev/null differ diff --git a/docs/admin/mgmt_commands/img/geoserver_postgis_params.png b/docs/admin/mgmt_commands/img/geoserver_postgis_params.png deleted file mode 100644 index 68362672fc5..00000000000 Binary files a/docs/admin/mgmt_commands/img/geoserver_postgis_params.png and /dev/null differ diff --git a/docs/admin/mgmt_commands/img/geoserver_publish_layers.png b/docs/admin/mgmt_commands/img/geoserver_publish_layers.png deleted file mode 100644 index ffb754d8f45..00000000000 Binary files a/docs/admin/mgmt_commands/img/geoserver_publish_layers.png and /dev/null differ diff --git a/docs/admin/mgmt_commands/img/geoserver_srs.png b/docs/admin/mgmt_commands/img/geoserver_srs.png deleted file mode 100644 index 7cf483a5b4b..00000000000 Binary files a/docs/admin/mgmt_commands/img/geoserver_srs.png and /dev/null differ diff --git a/docs/admin/mgmt_commands/img/geoserver_srs_2.png b/docs/admin/mgmt_commands/img/geoserver_srs_2.png deleted file mode 100644 index f5d40dee6fa..00000000000 Binary files a/docs/admin/mgmt_commands/img/geoserver_srs_2.png and /dev/null differ diff --git a/docs/admin/mgmt_commands/img/layer_batch_perms_admin.png b/docs/admin/mgmt_commands/img/layer_batch_perms_admin.png deleted file mode 100644 index cd675a0b0e5..00000000000 Binary files a/docs/admin/mgmt_commands/img/layer_batch_perms_admin.png and /dev/null differ diff --git a/docs/admin/mgmt_commands/img/layer_batch_perms_form.png b/docs/admin/mgmt_commands/img/layer_batch_perms_form.png deleted file mode 100644 index 358e3365264..00000000000 Binary files a/docs/admin/mgmt_commands/img/layer_batch_perms_form.png and /dev/null differ diff --git a/docs/admin/mgmt_commands/img/layer_info_vector.png b/docs/admin/mgmt_commands/img/layer_info_vector.png deleted file mode 100644 index 6bcc5879d95..00000000000 Binary files a/docs/admin/mgmt_commands/img/layer_info_vector.png and /dev/null differ diff --git a/docs/admin/mgmt_commands/img/menu_admin.png b/docs/admin/mgmt_commands/img/menu_admin.png deleted file mode 100644 index 2d91111b69f..00000000000 Binary files a/docs/admin/mgmt_commands/img/menu_admin.png and /dev/null differ diff --git a/docs/admin/mgmt_commands/img/permissions_django_admin.png b/docs/admin/mgmt_commands/img/permissions_django_admin.png deleted file mode 100644 index abfa0fc7bb7..00000000000 Binary files a/docs/admin/mgmt_commands/img/permissions_django_admin.png and /dev/null differ diff --git a/docs/admin/mgmt_commands/img/register.png b/docs/admin/mgmt_commands/img/register.png deleted file mode 100644 index 7106adbef4c..00000000000 Binary files a/docs/admin/mgmt_commands/img/register.png and /dev/null differ diff --git a/docs/admin/mgmt_commands/img/sign_up_test_user.png b/docs/admin/mgmt_commands/img/sign_up_test_user.png deleted file mode 100644 index 221b83bb10c..00000000000 Binary files a/docs/admin/mgmt_commands/img/sign_up_test_user.png and /dev/null differ diff --git a/docs/admin/mgmt_commands/img/tiled_vs_stripped.png b/docs/admin/mgmt_commands/img/tiled_vs_stripped.png deleted file mode 100644 index adeb0fb32d0..00000000000 Binary files a/docs/admin/mgmt_commands/img/tiled_vs_stripped.png and /dev/null differ diff --git a/docs/admin/mgmt_commands/img/upload_shapefile.png b/docs/admin/mgmt_commands/img/upload_shapefile.png deleted file mode 100644 index 99cc38b488f..00000000000 Binary files a/docs/admin/mgmt_commands/img/upload_shapefile.png and /dev/null differ diff --git a/docs/admin/mgmt_commands/index.rst b/docs/admin/mgmt_commands/index.rst deleted file mode 100644 index 21e7c3741b2..00000000000 --- a/docs/admin/mgmt_commands/index.rst +++ /dev/null @@ -1,1909 +0,0 @@ - -.. _migrate_baseurl: - -Migrate GeoNode Base URL -======================== - -The ``migrate_baseurl`` :guilabel:`Management Command` allows you to fix all the GeoNode Links whenever, for some reason, -you need to change the :guilabel:`Domain Name` of :guilabel:`IP Address` of GeoNode. - -This **must** be used also in the cases you'll need to chnage the network schema from ``HTTP`` to ``HTTPS``, as an instance. - -First of all let's take a look at the :guilabel:`--help` option of the ``migrate_baseurl`` -management command in order to inspect all the command options and features. - -Run - -.. code-block:: shell - - DJANGO_SETTINGS_MODULE=geonode.settings python manage.py migrate_baseurl --help - -.. note:: If you enabled ``local_settings.py`` the command will change as following: - - .. code-block:: shell - - DJANGO_SETTINGS_MODULE=geonode.local_settings python manage.py migrate_baseurl --help - -This will produce output that looks like the following - -.. code-block:: shell - - usage: manage.py migrate_baseurl [-h] [--version] [-v {0,1,2,3}] - [--settings SETTINGS] - [--pythonpath PYTHONPATH] [--traceback] - [--no-color] [-f] - [--source-address SOURCE_ADDRESS] - [--target-address TARGET_ADDRESS] - - Migrate GeoNode VM Base URL - - optional arguments: - -h, --help show this help message and exit - --version show program's version number and exit - -v {0,1,2,3}, --verbosity {0,1,2,3} - Verbosity level; 0=minimal output, 1=normal output, - 2=verbose output, 3=very verbose output - --settings SETTINGS The Python path to a settings module, e.g. - "myproject.settings.main". If this isn't provided, the - DJANGO_SETTINGS_MODULE environment variable will be - used. - --pythonpath PYTHONPATH - A directory to add to the Python path, e.g. - "/home/djangoprojects/myproject". - --traceback Raise on CommandError exceptions - --no-color Don't colorize the command output. - -f, --force Forces the execution without asking for confirmation. - --source-address SOURCE_ADDRESS - Source Address (the one currently on DB e.g. - http://192.168.1.23) - --target-address TARGET_ADDRESS - Target Address (the one to be changed e.g. http://my- - public.geonode.org) - -* **Example 1**: I want to move my GeoNode instance from ``http:\\127.0.0.1`` to ``http:\\example.org`` - - .. warning:: Make always sure you are using the **correct** settings - - .. code-block:: shell - - DJANGO_SETTINGS_MODULE=geonode.settings python manage.py migrate_baseurl --source-address=127.0.0.1 --target-address=example.org - -* **Example 2**: I want to move my GeoNode instance from ``http:\\example.org`` to ``https:\\example.org`` - - .. warning:: Make always sure you are using the **correct** settings - - .. code-block:: shell - - DJANGO_SETTINGS_MODULE=geonode.settings python manage.py migrate_baseurl --source-address=http:\\example.org --target-address=https:\\example.org - -* **Example 3**: I want to move my GeoNode instance from ``https:\\example.org`` to ``https:\\geonode.example.org`` - - .. warning:: Make always sure you are using the **correct** settings - - .. code-block:: shell - - DJANGO_SETTINGS_MODULE=geonode.settings python manage.py migrate_baseurl --source-address=example.org --target-address=geonode.example.org - -.. note:: After migrating the base URL, make sure to sanitize the links and catalog metadata also (:ref:`sync_layers_and_metadata`). - -.. _sync_layers_and_metadata: - -Update Permissions, Metadata, Legends and Download Links -======================================================== - -The following three utility :guilabel:`Management Commands`, allow to fixup: - -1. :guilabel:`Users/Groups Permissions` on :guilabel:`Layers`; those will be refreshed and synchronized with the :guilabel:`GIS Server` ones also - -2. :guilabel:`Metadata`, :guilabel:`Legend` and :guilabel:`Download` links on :guilabel:`Layers` and :guilabel:`Maps` - -3. Cleanup :guilabel:`Duplicated Links` and :guilabel:`Outdated Thumbnails` - -Management Command ``sync_geonode_layers`` ------------------------------------------- - -This command allows to sync already existing permissions on Layers. In order to change/set Layers' permissions refer to the section :ref:`batch_sync_permissions` - -The options are: - -* **filter**; Only update data the layer names that match the given filter. - -* **username**; Only update data owned by the specified username. - -* **updatepermissions**; Update the layer permissions; synchronize it back to the GeoSpatial Server. - This option is also available from the :guilabel:`Layer Details` page. - -* **updateattributes**; Update the layer attributes; synchronize it back to the GeoSpatial Server. - This option is also available from the :guilabel:`Layer Details` page. - -* **updatethumbnails**; Update the map styles and thumbnails. - This option is also available from the :guilabel:`Layer Details` page. - -* **remove-duplicates**; Removes duplicated Links. - -First of all let's take a look at the :guilabel:`--help` option of the ``sync_geonode_layers`` -management command in order to inspect all the command options and features. - -Run - -.. code-block:: shell - - DJANGO_SETTINGS_MODULE=geonode.settings python manage.py sync_geonode_layers --help - -.. note:: If you enabled ``local_settings.py`` the command will change as following: - - .. code-block:: shell - - DJANGO_SETTINGS_MODULE=geonode.local_settings python manage.py sync_geonode_layers --help - -This will produce output that looks like the following - -.. code-block:: shell - - usage: manage.py sync_geonode_layers [-h] [--version] [-v {0,1,2,3}] - [--settings SETTINGS] - [--pythonpath PYTHONPATH] [--traceback] - [--no-color] [-i] [-d] [-f FILTER] - [-u USERNAME] [--updatepermissions] - [--updatethumbnails] [--updateattributes] - - Update the GeoNode layers: permissions (including GeoFence database), - statistics, thumbnails - - optional arguments: - -h, --help show this help message and exit - --version show program's version number and exit - -v {0,1,2,3}, --verbosity {0,1,2,3} - Verbosity level; 0=minimal output, 1=normal output, - 2=verbose output, 3=very verbose output - --settings SETTINGS The Python path to a settings module, e.g. - "myproject.settings.main". If this isn't provided, the - DJANGO_SETTINGS_MODULE environment variable will be - used. - --pythonpath PYTHONPATH - A directory to add to the Python path, e.g. - "/home/djangoprojects/myproject". - --traceback Raise on CommandError exceptions - --no-color Don't colorize the command output. - -i, --ignore-errors Stop after any errors are encountered. - -d, --remove-duplicates - Remove duplicates first. - -f FILTER, --filter FILTER - Only update data the layers that match the given - filter. - -u USERNAME, --username USERNAME - Only update data owned by the specified username. - --updatepermissions Update the layer permissions. - --updatethumbnails Update the layer styles and thumbnails. - --updateattributes Update the layer attributes. - -* **Example 1**: I want to update/sync all layers permissions and attributes with the GeoSpatial Server - - .. warning:: Make always sure you are using the **correct** settings - - .. code-block:: shell - - DJANGO_SETTINGS_MODULE=geonode.settings python manage.py sync_geonode_layers --updatepermissions --updateattributes - -* **Example 2**: I want to regenerate the Thumbnails of all the Layers belonging to ``afabiani`` - - .. warning:: Make always sure you are using the **correct** settings - - .. code-block:: shell - - DJANGO_SETTINGS_MODULE=geonode.settings python manage.py sync_geonode_layers -u afabiani --updatethumbnails - -Management Command ``sync_geonode_maps`` ----------------------------------------- - -This command is basically similar to the previous one, but affects the :guilabel:`Maps`; with some limitations. - -The options are: - -* **filter**; Only update data the maps titles that match the given filter. - -* **username**; Only update data owned by the specified username. - -* **updatethumbnails**; Update the map styles and thumbnails. - This option is also available from the :guilabel:`Map Details` page. - -* **remove-duplicates**; Removes duplicated Links. - -First of all let's take a look at the :guilabel:`--help` option of the ``sync_geonode_maps`` -management command in order to inspect all the command options and features. - -Run - -.. code-block:: shell - - DJANGO_SETTINGS_MODULE=geonode.settings python manage.py sync_geonode_maps --help - -.. note:: If you enabled ``local_settings.py`` the command will change as following: - - .. code-block:: shell - - DJANGO_SETTINGS_MODULE=geonode.local_settings python manage.py sync_geonode_maps --help - -This will produce output that looks like the following - -.. code-block:: shell - - usage: manage.py sync_geonode_maps [-h] [--version] [-v {0,1,2,3}] - [--settings SETTINGS] - [--pythonpath PYTHONPATH] [--traceback] - [--no-color] [-i] [-d] [-f FILTER] - [-u USERNAME] [--updatethumbnails] - - Update the GeoNode maps: permissions, thumbnails - - optional arguments: - -h, --help show this help message and exit - --version show program's version number and exit - -v {0,1,2,3}, --verbosity {0,1,2,3} - Verbosity level; 0=minimal output, 1=normal output, - 2=verbose output, 3=very verbose output - --settings SETTINGS The Python path to a settings module, e.g. - "myproject.settings.main". If this isn't provided, the - DJANGO_SETTINGS_MODULE environment variable will be - used. - --pythonpath PYTHONPATH - A directory to add to the Python path, e.g. - "/home/djangoprojects/myproject". - --traceback Raise on CommandError exceptions - --no-color Don't colorize the command output. - -i, --ignore-errors Stop after any errors are encountered. - -d, --remove-duplicates - Remove duplicates first. - -f FILTER, --filter FILTER - Only update data the maps that match the given filter. - -u USERNAME, --username USERNAME - Only update data owned by the specified username. - --updatethumbnails Update the map styles and thumbnails. - -* **Example 1**: I want to regenerate the Thumbnail of the Map ``This is a test Map`` - - .. warning:: Make always sure you are using the **correct** settings - - .. code-block:: shell - - DJANGO_SETTINGS_MODULE=geonode.settings python manage.py sync_geonode_maps --updatethumbnails -f 'This is a test Map' - -Management Command ``set_all_layers_metadata`` ----------------------------------------------- - -This command allows to reset **Metadata Attributes** and **Catalogue Schema** on Layers. The command will also update the :guilabel:`CSW Catalogue` XML and Links of GeoNode. - -The options are: - -* **filter**; Only update data the layers that match the given filter. - -* **username**; Only update data owned by the specified username. - -* **remove-duplicates**; Update the map styles and thumbnails. - -* **delete-orphaned-thumbs**; Removes duplicated Links. - -First of all let's take a look at the :guilabel:`--help` option of the ``set_all_layers_metadata`` -management command in order to inspect all the command options and features. - -Run - -.. code-block:: shell - - DJANGO_SETTINGS_MODULE=geonode.settings python manage.py set_all_layers_metadata --help - -.. note:: If you enabled ``local_settings.py`` the command will change as following: - - .. code-block:: shell - - DJANGO_SETTINGS_MODULE=geonode.local_settings python manage.py set_all_layers_metadata --help - -This will produce output that looks like the following - -.. code-block:: shell - - usage: manage.py set_all_layers_metadata [-h] [--version] [-v {0,1,2,3}] - [--settings SETTINGS] - [--pythonpath PYTHONPATH] - [--traceback] [--no-color] [-i] [-d] - [-t] [-f FILTER] [-u USERNAME] - - Resets Metadata Attributes and Schema to All Layers - - optional arguments: - -h, --help show this help message and exit - --version show program's version number and exit - -v {0,1,2,3}, --verbosity {0,1,2,3} - Verbosity level; 0=minimal output, 1=normal output, - 2=verbose output, 3=very verbose output - --settings SETTINGS The Python path to a settings module, e.g. - "myproject.settings.main". If this isn't provided, the - DJANGO_SETTINGS_MODULE environment variable will be - used. - --pythonpath PYTHONPATH - A directory to add to the Python path, e.g. - "/home/djangoprojects/myproject". - --traceback Raise on CommandError exceptions - --no-color Don't colorize the command output. - -i, --ignore-errors Stop after any errors are encountered. - -d, --remove-duplicates - Remove duplicates first. - -t, --delete-orphaned-thumbs - Delete Orphaned Thumbnails. - -f FILTER, --filter FILTER - Only update data the layers that match the given - filter - -u USERNAME, --username USERNAME - Only update data owned by the specified username - -* **Example 1**: After having changed the Base URL, I want to regenerate all the Catalogue Schema and eventually remove all duplicates. - - .. warning:: Make always sure you are using the **correct** settings - - .. code-block:: shell - - DJANGO_SETTINGS_MODULE=geonode.settings python manage.py set_all_layers_metadata -d - -.. _load_data_into_geonode: - -Loading Data into GeoNode -========================= - -There are situations where it is not possible or not convenient to use the -:guilabel:`Upload Form` to add new Layers to GeoNode via the web interface. -As an instance: - -* The dataset is simply too big to be uploaded through a web interface. - -* We would like to import some data from the mass storage programmatically. - -* We would like to import some tables from a DataBase. - -* We need to process the data first and, maybe, transform it to another format. - -This section will walk you through the various options available to load data into your -GeoNode from GeoServer, from the command-line or programmatically. - -.. warning:: Some parts of this section have been taken from the `GeoServer `_ project and training documentation. - -.. _importlayers: - -Management Command ``importlayers`` ------------------------------------ - -The ``geonode.layers`` Django app includes 2 management commands that you can use to -load or configure data in your GeoNode. - -Both of them can be invoked by using the ``manage.py`` script. - -First of all let's take a look at the :guilabel:`--help` option of the ``importlayers`` -management command in order to inspect all the command options and features. - -Run - -.. code-block:: shell - - DJANGO_SETTINGS_MODULE=geonode.settings python manage.py importlayers --help - -.. note:: If you enabled ``local_settings.py`` the command will change as following: - - .. code-block:: shell - - DJANGO_SETTINGS_MODULE=geonode.local_settings python manage.py importlayers --help - -This will produce output that looks like the following - -.. code-block:: shell - - usage: manage.py importlayers [-h] [--version] [-v {0,1,2,3}] - [--settings SETTINGS] [--pythonpath PYTHONPATH] - [--traceback] [--no-color] [-u USER] [-i] [-o] - [-k KEYWORDS] [-l LICENSE] [-c CATEGORY] - [-r REGIONS] [-n LAYERNAME] [-t TITLE] - [-a ABSTRACT] [-d DATE] [-p] [-m] [-C CHARSET] - [path [path ...]] - - Brings a data file or a directory full of data files into a GeoNode site. - Layers are added to the Django database, the GeoServer configuration, and the - pycsw metadata index. - - positional arguments: - path path [path...] - - optional arguments: - -h, --help show this help message and exit - --version show program's version number and exit - -v {0,1,2,3}, --verbosity {0,1,2,3} - Verbosity level; 0=minimal output, 1=normal output, - 2=verbose output, 3=very verbose output - --settings SETTINGS The Python path to a settings module, e.g. - "myproject.settings.main". If this isn't provided, the - DJANGO_SETTINGS_MODULE environment variable will be - used. - --pythonpath PYTHONPATH - A directory to add to the Python path, e.g. - "/home/djangoprojects/myproject". - --traceback Raise on CommandError exceptions - --no-color Don't colorize the command output. - -u USER, --user USER Name of the user account which should own the imported - layers - -i, --ignore-errors Stop after any errors are encountered. - -o, --overwrite Overwrite existing layers if discovered (defaults - False) - -k KEYWORDS, --keywords KEYWORDS - The default keywords, separated by comma, for the - imported layer(s). Will be the same for all imported - layers if multiple imports are done in one command - -l LICENSE, --license LICENSE - The license for the imported layer(s). Will be the - same for all imported layers if multiple imports are - done in one command - -c CATEGORY, --category CATEGORY - The category for the imported layer(s). Will be the - same for all imported layers if multiple imports are - done in one command - -r REGIONS, --regions REGIONS - The default regions, separated by comma, for the - imported layer(s). Will be the same for all imported - layers if multiple imports are done in one command - -n LAYERNAME, --name LAYERNAME - The name for the imported layer(s). Can not be used - with multiple imports - -t TITLE, --title TITLE - The title for the imported layer(s). Will be the same - for all imported layers if multiple imports are done - in one command - -a ABSTRACT, --abstract ABSTRACT - The abstract for the imported layer(s). Will be the - same forall imported layers if multiple imports are - donein one command - -d DATE, --date DATE The date and time for the imported layer(s). Will be - the same for all imported layers if multiple imports - are done in one command. Use quotes to specify both - the date and time in the format 'YYYY-MM-DD HH:MM:SS'. - -p, --private Make layer viewable only to owner - -m, --metadata_uploaded_preserve - Force metadata XML to be preserved - -C CHARSET, --charset CHARSET - Specify the charset of the data - -While the description of most of the options should be self explanatory, its worth -reviewing some of the key options a bit more in details. - -- The :guilabel:`-i` option will force the command to stop when it first encounters an error. Without this option specified, the process will skip over errors that have layers and continue loading the other layers. -- The :guilabel:`-o` option specifies that layers with the same name as the base name will be loaded and overwrite the existing layer. -- The :guilabel:`-u` option specifies which will be the user that owns the imported layers. The same user will be the point of contact and the metadata author as well for that layer -- The :guilabel:`-k` option is used to add keywords for all of the layers imported. -- The :guilabel:`-C` option specifies the character encoding of the data. - -The import layers management command is invoked by specifying options as described -above and specifying the path to a single layer file or to a directory that contains multiple files. For purposes of this exercise, lets use the default set of testing layers that ship with geonode. -You can replace this path with the directory to your own shapefiles. - -.. code-block:: shell - - DJANGO_SETTINGS_MODULE=geonode.settings python manage.py importlayers -v 3 /var/lib/geonode/lib/python2.7/site-packages/gisdata/data/good/vector/ - -This command will produce the following output to your terminal - -.. code-block:: shell - - Verifying that GeoNode is running ... - Found 8 potential layers. - No handlers could be found for logger "pycsw" - [created] Layer for '/Users/geosolutions/.venvs/geonode/lib/python2.7/site-packages/gisdata/data/good/vector/san_andres_y_providencia_administrative.shp' (1/8) - [created] Layer for '/Users/geosolutions/.venvs/geonode/lib/python2.7/site-packages/gisdata/data/good/vector/san_andres_y_providencia_coastline.shp' (2/8) - [created] Layer for '/Users/geosolutions/.venvs/geonode/lib/python2.7/site-packages/gisdata/data/good/vector/san_andres_y_providencia_highway.shp' (3/8) - [created] Layer for '/Users/geosolutions/.venvs/geonode/lib/python2.7/site-packages/gisdata/data/good/vector/san_andres_y_providencia_location.shp' (4/8) - [created] Layer for '/Users/geosolutions/.venvs/geonode/lib/python2.7/site-packages/gisdata/data/good/vector/san_andres_y_providencia_natural.shp' (5/8) - [created] Layer for '/Users/geosolutions/.venvs/geonode/lib/python2.7/site-packages/gisdata/data/good/vector/san_andres_y_providencia_poi.shp' (6/8) - [created] Layer for '/Users/geosolutions/.venvs/geonode/lib/python2.7/site-packages/gisdata/data/good/vector/san_andres_y_providencia_water.shp' (7/8) - [created] Layer for '/Users/geosolutions/.venvs/geonode/lib/python2.7/site-packages/gisdata/data/good/vector/single_point.shp' (8/8) - - Detailed report of failures: - - Finished processing 8 layers in 30.0 seconds. - - 8 Created layers - 0 Updated layers - 0 Skipped layers - 0 Failed layers - 3.750000 seconds per layer - -If you encounter errors while running this command, you can use the :guilabel:`-v` -option to increase the verbosity of the output so you can debug the problem. - -The verbosity level can be set from :guilabel:`0-3` with :guilabel:`0` being the default. - -An example of what the output looks like when an error is encountered and the verbosity -is set to :guilabel:`3` is shown below: - -.. code-block:: shell - - Verifying that GeoNode is running ... - Found 8 potential layers. - [failed] Layer for '/Users/geosolutions/.venvs/geonode/lib/python2.7/site-packages/gisdata/data/good/vector/san_andres_y_providencia_administrative.shp' (1/8) - [failed] Layer for '/Users/geosolutions/.venvs/geonode/lib/python2.7/site-packages/gisdata/data/good/vector/san_andres_y_providencia_coastline.shp' (2/8) - [failed] Layer for '/Users/geosolutions/.venvs/geonode/lib/python2.7/site-packages/gisdata/data/good/vector/san_andres_y_providencia_highway.shp' (3/8) - [failed] Layer for '/Users/geosolutions/.venvs/geonode/lib/python2.7/site-packages/gisdata/data/good/vector/san_andres_y_providencia_location.shp' (4/8) - [failed] Layer for '/Users/geosolutions/.venvs/geonode/lib/python2.7/site-packages/gisdata/data/good/vector/san_andres_y_providencia_natural.shp' (5/8) - [failed] Layer for '/Users/geosolutions/.venvs/geonode/lib/python2.7/site-packages/gisdata/data/good/vector/san_andres_y_providencia_poi.shp' (6/8) - [failed] Layer for '/Users/geosolutions/.venvs/geonode/lib/python2.7/site-packages/gisdata/data/good/vector/san_andres_y_providencia_water.shp' (7/8) - [failed] Layer for '/Users/geosolutions/.venvs/geonode/lib/python2.7/site-packages/gisdata/data/good/vector/single_point.shp' (8/8) - - Detailed report of failures: - - /Users/geosolutions/.venvs/geonode/lib/python2.7/site-packages/gisdata/data/good/vector/san_andres_y_providencia_administrative.shp - ================ - Traceback (most recent call last): - File "/Users/geosolutions/projects/geonode/geonode/layers/utils.py", line 682, in upload - keywords=keywords, - File "/Users/geosolutions/projects/geonode/geonode/layers/utils.py", line 602, in file_upload - keywords=keywords, title=title) - File "/Users/geosolutions/projects/geonode/geonode/layers/utils.py", line 305, in save - store = cat.get_store(name) - File "/Users/geosolutions/.venvs/geonode/lib/python2.7/site-packages/geoserver/catalog.py", line 176, in get_store - for ws in self.get_workspaces(): - File "/Users/geosolutions/.venvs/geonode/lib/python2.7/site-packages/geoserver/catalog.py", line 489, in get_workspaces - description = self.get_xml("%s/workspaces.xml" % self.service_url) - File "/Users/geosolutions/.venvs/geonode/lib/python2.7/site-packages/geoserver/catalog.py", line 136, in get_xml - response, content = self.http.request(rest_url) - File "/Library/Python/2.7/site-packages/httplib2/__init__.py", line 1445, in request - (response, content) = self._request(conn, authority, uri, request_uri, method, body, headers, redirections, cachekey) - File "/Library/Python/2.7/site-packages/httplib2/__init__.py", line 1197, in _request - (response, content) = self._conn_request(conn, request_uri, method, body, headers) - File "/Library/Python/2.7/site-packages/httplib2/__init__.py", line 1133, in _conn_request - conn.connect() - File "/Library/Python/2.7/site-packages/httplib2/__init__.py", line 799, in connect - raise socket.error, msg - error: [Errno 61] Connection refused - -.. note:: This last section of output will be repeated for all layers, and only the first one is show above. - -This error indicates that GeoNode was unable to connect to GeoServer to load the layers. -To solve this, you should make sure GeoServer is running and re-run the command. - -If you encounter errors with this command that you cannot solve, -you should bring them up on the geonode users mailing list. - -You should now have the knowledge necessary to import layers into your GeoNode project -from a directory on the servers filesystem and can use this to load many layers into -your GeoNode at once. - -.. note:: If you do not use the :guilabel:`-u` command option, the ownership of the imported layers will be assigned to the primary superuser in your system. You can use GeoNodes Django Admin interface to modify this after the fact if you want them to be owned by another user. - -.. _updatelayers: - -Management Command ``updatelayers`` ------------------------------------ - -While it is possible to import layers directly from your servers filesystem into your -GeoNode, you may have an existing GeoServer that already has data in it, or you may -want to configure data from a GeoServer which is not directly supported by uploading data. - -GeoServer supports a wide range of data formats and connections to database, and while -many of them are not supported as GeoNode upload formats, if they can be configured in -GeoServer, you can add them to your GeoNode by following the procedure described below. - -GeoServer supports 3 types of data: :guilabel:`Raster`, :guilabel:`Vector`, :guilabel:`Databases` and :guilabel:`Cascaded`. - -For a list of the supported formats for each type of data, consult the following pages: - -- https://docs.geoserver.org/latest/en/user/data/vector/index.html -- https://docs.geoserver.org/latest/en/user/data/raster/index.html -- https://docs.geoserver.org/latest/en/user/data/database/index.html -- https://docs.geoserver.org/latest/en/user/data/cascaded/index.html - -.. note:: Some of these raster or vector formats or database types require that you install specific plugins in your GeoServer in order to use the. Please consult the GeoServer documentation for more information. - -Data from a PostGIS database -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Lets walk through an example of configuring a new PostGIS database in GeoServer and then -configuring those layers in your GeoNode. - -First visit the GeoServer administration interface on your server. This is usually on port 8080 and is available at http://localhost:8080/geoserver/web/ - -1. You should login with the superuser credentials you setup when you first configured your GeoNode instance. - - Once you are logged in to the GeoServer Admin interface, you should see the following. - - .. figure:: img/geoserver_admin.png - :align: center - - .. note:: The number of stores, layers and workspaces may be different depending on what you already have configured in your GeoServer. - -2. Next you want to select the "Stores" option in the left hand menu, and then the "Add new Store" option. The following screen will be displayed. - - .. figure:: img/geoserver_new_store.png - :align: center - -3. In this case, we want to select the PostGIS store type to create a connection to our existing database. On the next screen you will need to enter the parameters to connect to your PostGIS database (alter as necessary for your own database). - - .. figure:: img/geoserver_postgis_params.png - :align: center - - .. note:: If you are unsure about any of the settings, leave them as the default. - -4. The next screen lets you configure the layers in your database. This will of course be different depending on the layers in your database. - - .. figure:: img/geoserver_publish_layers.png - :align: center - -5. Select the "Publish" button for one of the layers and the next screen will be displayed where you can enter metadata for this layer. Since we will be managing this metadata in GeoNode, we can leave these alone for now. - - .. figure:: img/geoserver_layer_params.png - :align: center - -6. The things that *must* be specified are the Declared SRS and you must select the "Compute from Data" and "Compute from native bounds" links after the SRS is specified. - - .. figure:: img/geoserver_srs.png - :align: center - - .. figure:: img/geoserver_srs_2.png - :align: center - -7. Click save and this layer will now be configured for use in your GeoServer. - - .. figure:: img/geoserver_layers.png - :align: center - -8. The next step is to configure these layers in GeoNode. The ``updatelayers`` management command can be used for this purpose. As with ``importlayers``, it's useful to look at the command line options for this command by passing the :guilabel:`--help` option - - Run - - .. code-block:: shell - - DJANGO_SETTINGS_MODULE=geonode.settings python manage.py updatelayers --help - - .. note:: If you enabled ``local_settings.py`` the command will change as following: - - .. code-block:: shell - - DJANGO_SETTINGS_MODULE=geonode.local_settings python manage.py updatelayers --help - - This will produce output that looks like the following - - .. code-block:: shell - - usage: manage.py updatelayers [-h] [--version] [-v {0,1,2,3}] - [--settings SETTINGS] [--pythonpath PYTHONPATH] - [--traceback] [--no-color] [-i] - [--skip-unadvertised] - [--skip-geonode-registered] [--remove-deleted] - [-u USER] [-f FILTER] [-s STORE] [-w WORKSPACE] - [-p PERMISSIONS] - - Update the GeoNode application with data from GeoServer - - optional arguments: - -h, --help show this help message and exit - --version show program's version number and exit - -v {0,1,2,3}, --verbosity {0,1,2,3} - Verbosity level; 0=minimal output, 1=normal output, - 2=verbose output, 3=very verbose output - --settings SETTINGS The Python path to a settings module, e.g. - "myproject.settings.main". If this isn't provided, the - DJANGO_SETTINGS_MODULE environment variable will be - used. - --pythonpath PYTHONPATH - A directory to add to the Python path, e.g. - "/home/djangoprojects/myproject". - --traceback Raise on CommandError exceptions - --no-color Don't colorize the command output. - -i, --ignore-errors Stop after any errors are encountered. - --skip-unadvertised Skip processing unadvertised layers from GeoSever. - --skip-geonode-registered - Just processing GeoServer layers still not registered - in GeoNode. - --remove-deleted Remove GeoNode layers that have been deleted from - GeoSever. - -u USER, --user USER Name of the user account which should own the imported - layers - -f FILTER, --filter FILTER - Only update data the layers that match the given - filter - -s STORE, --store STORE - Only update data the layers for the given geoserver - store name - -w WORKSPACE, --workspace WORKSPACE - Only update data on specified workspace - -p PERMISSIONS, --permissions PERMISSIONS - Permissions to apply to each layer - -.. warning:: One of the :guilabel:`--workspace` or :guilabel:`--store` must be always specified if you want to ingest Layers belonging to a specific ``Workspace``. As an instance, in order to ingest the layers present into the ``geonode`` workspace, you will need to spceify the option ``-w geonode``. - -9. Let's ingest the layer ``geonode:_1_SARMIENTO_ENERO_2018`` from the ``geonode`` workspace. - - .. code-block:: shell - - DJANGO_SETTINGS_MODULE=geonode.settings python manage.py updatelayers -w geonode -f _1_SARMIENTO_ENERO_2018 - - .. code-block:: shell - - Inspecting the available layers in GeoServer ... - Found 1 layers, starting processing - /usr/local/lib/python2.7/site-packages/owslib/iso.py:117: FutureWarning: the .identification and .serviceidentification properties will merge into .identification being a list of properties. This is currently implemented in .identificationinfo. Please see https://github.com/geopython/OWSLib/issues/38 for more information - FutureWarning) - /usr/local/lib/python2.7/site-packages/owslib/iso.py:495: FutureWarning: The .keywords and .keywords2 properties will merge into the .keywords property in the future, with .keywords becoming a list of MD_Keywords instances. This is currently implemented in .keywords2. Please see https://github.com/geopython/OWSLib/issues/301 for more information - FutureWarning) - Content-Type: text/html; charset="utf-8" - MIME-Version: 1.0 - Content-Transfer-Encoding: 7bit - Subject: [master.demo.geonode.org] A new layer has been uploaded - From: webmaster@localhost - To: mapadeldelito@chubut.gov.ar - Reply-To: webmaster@localhost - Date: Tue, 08 Oct 2019 12:26:17 -0000 - Message-ID: <20191008122617.28801.94967@d3cf85425231> - - - - You have received the following notice from master.demo.geonode.org: -

    - - The user admin uploaded the following layer:
    - _1_SARMIENTO_ENERO_2018
    - You can visit the layer's detail page here: http://master.demo.geonode.org/layers/geonode:_1_SARMIENTO_ENERO_2018 - -

    -

    - To change how you receive notifications, please go to http://master.demo.geonode.org -

    - - - ------------------------------------------------------------------------------- - Content-Type: text/html; charset="utf-8" - MIME-Version: 1.0 - Content-Transfer-Encoding: 7bit - Subject: [master.demo.geonode.org] A new layer has been uploaded - From: webmaster@localhost - To: giacomo8vinci@gmail.com - Reply-To: webmaster@localhost - Date: Tue, 08 Oct 2019 12:26:17 -0000 - Message-ID: <20191008122617.28801.53784@d3cf85425231> - - - - You have received the following notice from master.demo.geonode.org: -

    - - The user admin uploaded the following layer:
    - _1_SARMIENTO_ENERO_2018
    - You can visit the layer's detail page here: http://master.demo.geonode.org/layers/geonode:_1_SARMIENTO_ENERO_2018 - -

    -

    - To change how you receive notifications, please go to http://master.demo.geonode.org -

    - - - ------------------------------------------------------------------------------- - Content-Type: text/html; charset="utf-8" - MIME-Version: 1.0 - Content-Transfer-Encoding: 7bit - Subject: [master.demo.geonode.org] A new layer has been uploaded - From: webmaster@localhost - To: fmgagliano@gmail.com - Reply-To: webmaster@localhost - Date: Tue, 08 Oct 2019 12:26:17 -0000 - Message-ID: <20191008122617.28801.26265@d3cf85425231> - - - - You have received the following notice from master.demo.geonode.org: -

    - - The user admin uploaded the following layer:
    - _1_SARMIENTO_ENERO_2018
    - You can visit the layer's detail page here: http://master.demo.geonode.org/layers/geonode:_1_SARMIENTO_ENERO_2018 - -

    -

    - To change how you receive notifications, please go to http://master.demo.geonode.org -

    - - - ------------------------------------------------------------------------------- - Found geoserver resource for this layer: _1_SARMIENTO_ENERO_2018 - ... Creating Default Resource Links for Layer [geonode:_1_SARMIENTO_ENERO_2018] - -- Resource Links[Prune old links]... - -- Resource Links[Prune old links]...done! - -- Resource Links[Compute parameters for the new links]... - -- Resource Links[Create Raw Data download link]... - -- Resource Links[Create Raw Data download link]...done! - -- Resource Links[Set download links for WMS, WCS or WFS and KML]... - -- Resource Links[Set download links for WMS, WCS or WFS and KML]...done! - -- Resource Links[Legend link]... - -- Resource Links[Legend link]...done! - -- Resource Links[Thumbnail link]... - -- Resource Links[Thumbnail link]...done! - -- Resource Links[OWS Links]... - -- Resource Links[OWS Links]...done! - Content-Type: text/html; charset="utf-8" - MIME-Version: 1.0 - Content-Transfer-Encoding: 7bit - Subject: [master.demo.geonode.org] A layer has been updated - From: webmaster@localhost - To: mapadeldelito@chubut.gov.ar - Reply-To: webmaster@localhost - Date: Tue, 08 Oct 2019 12:26:20 -0000 - Message-ID: <20191008122620.28801.81598@d3cf85425231> - - - - You have received the following notice from master.demo.geonode.org: -

    - - The following layer was updated:
    - _1_SARMIENTO_ENERO_2018, owned by admin
    - You can visit the layer's detail page here: http://master.demo.geonode.org/layers/geonode:_1_SARMIENTO_ENERO_2018 - -

    -

    - To change how you receive notifications, please go to http://master.demo.geonode.org -

    - - - ------------------------------------------------------------------------------- - Content-Type: text/html; charset="utf-8" - MIME-Version: 1.0 - Content-Transfer-Encoding: 7bit - Subject: [master.demo.geonode.org] A layer has been updated - From: webmaster@localhost - To: giacomo8vinci@gmail.com - Reply-To: webmaster@localhost - Date: Tue, 08 Oct 2019 12:26:20 -0000 - Message-ID: <20191008122620.28801.93778@d3cf85425231> - - - - You have received the following notice from master.demo.geonode.org: -

    - - The following layer was updated:
    - _1_SARMIENTO_ENERO_2018, owned by admin
    - You can visit the layer's detail page here: http://master.demo.geonode.org/layers/geonode:_1_SARMIENTO_ENERO_2018 - -

    -

    - To change how you receive notifications, please go to http://master.demo.geonode.org -

    - - - ------------------------------------------------------------------------------- - Content-Type: text/html; charset="utf-8" - MIME-Version: 1.0 - Content-Transfer-Encoding: 7bit - Subject: [master.demo.geonode.org] A layer has been updated - From: webmaster@localhost - To: fmgagliano@gmail.com - Reply-To: webmaster@localhost - Date: Tue, 08 Oct 2019 12:26:20 -0000 - Message-ID: <20191008122620.28801.58585@d3cf85425231> - - - - You have received the following notice from master.demo.geonode.org: -

    - - The following layer was updated:
    - _1_SARMIENTO_ENERO_2018, owned by admin
    - You can visit the layer's detail page here: http://master.demo.geonode.org/layers/geonode:_1_SARMIENTO_ENERO_2018 - -

    -

    - To change how you receive notifications, please go to http://master.demo.geonode.org -

    - - - ------------------------------------------------------------------------------- - Found geoserver resource for this layer: _1_SARMIENTO_ENERO_2018 - /usr/local/lib/python2.7/site-packages/geoserver/style.py:80: FutureWarning: The behavior of this method will change in future versions. Use specific 'len(elem)' or 'elem is not None' test instead. - if not user_style: - /usr/local/lib/python2.7/site-packages/geoserver/style.py:84: FutureWarning: The behavior of this method will change in future versions. Use specific 'len(elem)' or 'elem is not None' test instead. - if user_style: - ... Creating Default Resource Links for Layer [geonode:_1_SARMIENTO_ENERO_2018] - -- Resource Links[Prune old links]... - -- Resource Links[Prune old links]...done! - -- Resource Links[Compute parameters for the new links]... - -- Resource Links[Create Raw Data download link]... - -- Resource Links[Create Raw Data download link]...done! - -- Resource Links[Set download links for WMS, WCS or WFS and KML]... - -- Resource Links[Set download links for WMS, WCS or WFS and KML]...done! - -- Resource Links[Legend link]... - -- Resource Links[Legend link]...done! - -- Resource Links[Thumbnail link]... - -- Resource Links[Thumbnail link]...done! - -- Resource Links[OWS Links]... - -- Resource Links[OWS Links]...done! - [created] Layer _1_SARMIENTO_ENERO_2018 (1/1) - - - Finished processing 1 layers in 5.0 seconds. - - 1 Created layers - 0 Updated layers - 0 Failed layers - 5.000000 seconds per layer - -.. note:: In case you don't specify the :guilabel:`-f` option, the layers that already exist in your GeoNode will be just updated and the configuration synchronized between GeoServer and GeoNode. - -.. warning:: When updating **from** GeoServer, the configuration on GeoNode will be changed! - -.. _gdal_ogr_data_processing: - -Using ``GDAL`` and ``OGR`` to convert your Data for use in GeoNode ------------------------------------------------------------------- - -GeoNode supports uploading data in :guilabel:`ESRI shapefiles`, :guilabel:`GeoTIFF`, :guilabel:`CSV`, :guilabel:`GeoJSON`, :guilabel:`ASCII-GRID` and :guilabel:`KML / KMZ` formats (for the last three formats only if you are using the ``geonode.importer`` backend). - -* If your data is in other formats, you will need to convert it into one of these formats for use in GeoNode. - -* If your :guilabel:`Raster` data is not correctly processed, it might be almost unusable with GeoServer and GeoNode. You will need to process it using `GDAL`. - -You need to make sure that you have the GDAL library installed on your system. -On Ubuntu you can install this package with the following command: - -.. code-block:: shell - - sudo apt-get install gdal-bin - -OGR (Vector Data) -^^^^^^^^^^^^^^^^^ - -OGR is used to manipulate vector data. In this example, we will use MapInfo .tab files and convert them to shapefiles with the ogr2ogr command. We will use sample MapInfo files from the website linked below. - -http://services.land.vic.gov.au/landchannel/content/help?name=sampledata - -You can download the Admin;(Postcode) layer by issuing the following command:: - - $ wget http://services.land.vic.gov.au/sampledata/shape/admin_postcode_vm.zip - -You will need to unzip this dataset by issuing the following command:: - - $ unzip admin_postcode_vm.zip - -This will leave you with the following files in the directory where you executed the above commands:: - - |-- ANZVI0803003025.htm - |-- DSE_Data_Access_Licence.pdf - |-- VMADMIN.POSTCODE_POLYGON.xml - |-- admin_postcode_vm.zip - --- vicgrid94 - --- mif - --- lga_polygon - --- macedon\ ranges - |-- EXTRACT_POLYGON.mid - |-- EXTRACT_POLYGON.mif - --- VMADMIN - |-- POSTCODE_POLYGON.mid - --- POSTCODE_POLYGON.mif - -First, lets inspect this file set using the following command:: - - $ ogrinfo -so vicgrid94/mif/lga_polygon/macedon\ ranges/VMADMIN/POSTCODE_POLYGON.mid POSTCODE_POLYGON - -The output will look like the following:: - - Had to open data source read-only. - INFO: Open of `vicgrid94/mif/lga_polygon/macedon ranges/VMADMIN/POSTCODE_POLYGON.mid' - using driver `MapInfo File' successful. - - Layer name: POSTCODE_POLYGON - Geometry: 3D Unknown (any) - Feature Count: 26 - Extent: (2413931.249367, 2400162.366186) - (2508952.174431, 2512183.046927) - Layer SRS WKT: - PROJCS["unnamed", - GEOGCS["unnamed", - DATUM["GDA94", - SPHEROID["GRS 80",6378137,298.257222101], - TOWGS84[0,0,0,-0,-0,-0,0]], - PRIMEM["Greenwich",0], - UNIT["degree",0.0174532925199433]], - PROJECTION["Lambert_Conformal_Conic_2SP"], - PARAMETER["standard_parallel_1",-36], - PARAMETER["standard_parallel_2",-38], - PARAMETER["latitude_of_origin",-37], - PARAMETER["central_meridian",145], - PARAMETER["false_easting",2500000], - PARAMETER["false_northing",2500000], - UNIT["Meter",1]] - PFI: String (10.0) - POSTCODE: String (4.0) - FEATURE_TYPE: String (6.0) - FEATURE_QUALITY_ID: String (20.0) - PFI_CREATED: Date (10.0) - UFI: Real (12.0) - UFI_CREATED: Date (10.0) - UFI_OLD: Real (12.0) - -This gives you information about the number of features, the extent, the projection and the attributes of this layer. - -Next, lets go ahead and convert this layer into a shapefile by issuing the following command:: - - $ ogr2ogr -t_srs EPSG:4326 postcode_polygon.shp vicgrid94/mif/lga_polygon/macedon\ ranges/VMADMIN/POSTCODE_POLYGON.mid POSTCODE_POLYGON - -Note that we have also reprojected the layer to the WGS84 spatial reference system with the -t_srs ogr2ogr option. - -The output of this command will look like the following:: - - Warning 6: Normalized/laundered field name: 'FEATURE_TYPE' to 'FEATURE_TY' - Warning 6: Normalized/laundered field name: 'FEATURE_QUALITY_ID' to 'FEATURE_QU' - Warning 6: Normalized/laundered field name: 'PFI_CREATED' to 'PFI_CREATE' - Warning 6: Normalized/laundered field name: 'UFI_CREATED' to 'UFI_CREATE' - -This output indicates that some of the field names were truncated to fit into the constraint that attributes in shapefiles are only 10 characters long. - -You will now have a set of files that make up the postcode_polygon.shp shapefile set. We can inspect them by issuing the following command:: - - $ ogrinfo -so postcode_polygon.shp postcode_polygon - -The output will look similar to the output we saw above when we inspected the MapInfo file we converted from:: - - INFO: Open of `postcode_polygon.shp' - using driver `ESRI Shapefile' successful. - - Layer name: postcode_polygon - Geometry: Polygon - Feature Count: 26 - Extent: (144.030296, -37.898156) - (145.101137, -36.888878) - Layer SRS WKT: - GEOGCS["GCS_WGS_1984", - DATUM["WGS_1984", - SPHEROID["WGS_84",6378137,298.257223563]], - PRIMEM["Greenwich",0], - UNIT["Degree",0.017453292519943295]] - PFI: String (10.0) - POSTCODE: String (4.0) - FEATURE_TY: String (6.0) - FEATURE_QU: String (20.0) - PFI_CREATE: Date (10.0) - UFI: Real (12.0) - UFI_CREATE: Date (10.0) - UFI_OLD: Real (12.0) - -These files can now be loaded into your GeoNode instance via the normal uploader. - -Visit the upload page in your GeoNode, drag and drop the files that composes the shapefile that you have generated using the GDAL ogr2ogr command (postcode_polygon.dbf, postcode_polygon.prj, postcode_polygon.shp, postcode_polygon.shx). Give the permissions as needed and then click the "Upload files" button. - -.. figure:: img/upload_shapefile.png - :align: center - -As soon as the import process completes, you will have the possibility to go straight to the layer info page ("Layer Info" button), or to edit the metadata for that layer ("Edit Metadata" button), or to manage the styles for that layer ("Manage Styles"). - -.. figure:: img/layer_info_vector.png - :align: center - -GDAL (Raster Data) -^^^^^^^^^^^^^^^^^^ - -Let's see several examples on how to either convert raster data into different formats and/or process it to get the best performances. - -References: - -a) https://geoserver.geo-solutions.it/edu/en/raster_data/processing.html - -b) https://geoserver.geo-solutions.it/edu/en/raster_data/advanced_gdal/ - -Raster Data Conversion: Arc/Info Binary and ASCII Grid data into GeoTIFF format. -++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ - -Let's assume we have a sample ASCII Grid file compressed as an archive. - -.. code-block:: shell - - # Un-tar the files - tar -xvf sample_asc.tar - -You will be left with the following files on your filesystem: - -.. code-block:: shell - - |-- batemans_ele - |   |-- dblbnd.adf - |   |-- hdr.adf - |   |-- metadata.xml - |   |-- prj.adf - |   |-- sta.adf - |   |-- w001001.adf - |   |-- w001001x.adf - |-- batemans_elevation.asc - -The file ``batemans_elevation.asc`` is an Arc/Info ASCII Grid file and the files in -the batemans_ele directory are an Arc/Info Binary Grid file. - -You can use the ``gdalinfo`` command to inspect both of these files by executing the -following command: - -.. code-block:: shell - - gdalinfo batemans_elevation.asc - -The output should look like the following: - -.. code-block:: shell - - Driver: AAIGrid/Arc/Info ASCII Grid - Files: batemans_elevation.asc - Size is 155, 142 - Coordinate System is `' - Origin = (239681.000000000000000,6050551.000000000000000) - Pixel Size = (100.000000000000000,-100.000000000000000) - Corner Coordinates: - Upper Left ( 239681.000, 6050551.000) - Lower Left ( 239681.000, 6036351.000) - Upper Right ( 255181.000, 6050551.000) - Lower Right ( 255181.000, 6036351.000) - Center ( 247431.000, 6043451.000) - Band 1 Block=155x1 Type=Float32, ColorInterp=Undefined - NoData Value=-9999 - -You can then inspect the batemans_ele files by executing the following command: - -.. code-block:: shell - - gdalinfo batemans_ele - -And this should be the corresponding output: - -.. code-block:: shell - - Driver: AIG/Arc/Info Binary Grid - Files: batemans_ele - batemans_ele/dblbnd.adf - batemans_ele/hdr.adf - batemans_ele/metadata.xml - batemans_ele/prj.adf - batemans_ele/sta.adf - batemans_ele/w001001.adf - batemans_ele/w001001x.adf - Size is 155, 142 - Coordinate System is: - PROJCS["unnamed", - GEOGCS["GDA94", - DATUM["Geocentric_Datum_of_Australia_1994", - SPHEROID["GRS 1980",6378137,298.257222101, - AUTHORITY["EPSG","7019"]], - TOWGS84[0,0,0,0,0,0,0], - AUTHORITY["EPSG","6283"]], - PRIMEM["Greenwich",0, - AUTHORITY["EPSG","8901"]], - UNIT["degree",0.0174532925199433, - AUTHORITY["EPSG","9122"]], - AUTHORITY["EPSG","4283"]], - PROJECTION["Transverse_Mercator"], - PARAMETER["latitude_of_origin",0], - PARAMETER["central_meridian",153], - PARAMETER["scale_factor",0.9996], - PARAMETER["false_easting",500000], - PARAMETER["false_northing",10000000], - UNIT["METERS",1]] - Origin = (239681.000000000000000,6050551.000000000000000) - Pixel Size = (100.000000000000000,-100.000000000000000) - Corner Coordinates: - Upper Left ( 239681.000, 6050551.000) (150d 7'28.35"E, 35d39'16.56"S) - Lower Left ( 239681.000, 6036351.000) (150d 7'11.78"E, 35d46'56.89"S) - Upper Right ( 255181.000, 6050551.000) (150d17'44.07"E, 35d39'30.83"S) - Lower Right ( 255181.000, 6036351.000) (150d17'28.49"E, 35d47'11.23"S) - Center ( 247431.000, 6043451.000) (150d12'28.17"E, 35d43'13.99"S) - Band 1 Block=256x4 Type=Float32, ColorInterp=Undefined - Min=-62.102 Max=142.917 - NoData Value=-3.4028234663852886e+38 - -You will notice that the ``batemans_elevation.asc`` file does *not* contain projection information while the ``batemans_ele`` file does. -Because of this, lets use the ``batemans_ele`` files for this exercise and convert them to a GeoTiff for use in GeoNode. -We will also reproject this file into WGS84 in the process. This can be accomplished with the following command. - -.. code-block:: shell - - gdalwarp -t_srs EPSG:4326 batemans_ele batemans_ele.tif - -The output will show you the progress of the conversion and when it is complete, -you will be left with a ``batemans_ele.tif`` file that you can upload to your GeoNode. - -You can inspect this file with the gdalinfo command: - -.. code-block:: shell - - gdalinfo batemans_ele.tif - -Which will produce the following output: - -.. code-block:: shell - - Driver: GTiff/GeoTIFF - Files: batemans_ele.tif - Size is 174, 130 - Coordinate System is: - GEOGCS["WGS 84", - DATUM["WGS_1984", - SPHEROID["WGS 84",6378137,298.257223563, - AUTHORITY["EPSG","7030"]], - AUTHORITY["EPSG","6326"]], - PRIMEM["Greenwich",0], - UNIT["degree",0.0174532925199433], - AUTHORITY["EPSG","4326"]] - Origin = (150.119938943722502,-35.654598806259330) - Pixel Size = (0.001011114155919,-0.001011114155919) - Metadata: - AREA_OR_POINT=Area - Image Structure Metadata: - INTERLEAVE=BAND - Corner Coordinates: - Upper Left ( 150.1199389, -35.6545988) (150d 7'11.78"E, 35d39'16.56"S) - Lower Left ( 150.1199389, -35.7860436) (150d 7'11.78"E, 35d47' 9.76"S) - Upper Right ( 150.2958728, -35.6545988) (150d17'45.14"E, 35d39'16.56"S) - Lower Right ( 150.2958728, -35.7860436) (150d17'45.14"E, 35d47' 9.76"S) - Center ( 150.2079059, -35.7203212) (150d12'28.46"E, 35d43'13.16"S) - Band 1 Block=174x11 Type=Float32, ColorInterp=Gray - -Raster Data Optimization: Optimizing and serving big raster data -++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ - -(ref: https://geoserver.geo-solutions.it/edu/en/raster_data/advanced_gdal/example5.html) - -When dealing with big raster datasets it could be very useful to use tiles. - -Tiling allows large raster datasets to be broken-up into manageable pieces and are fundamental -in defining and implementing an higher level raster I/O interface. - -In this example we will use the original dataset of the ``chiangMai_ortho_optimized`` public raster layer which -is currently available on the Thai `CHIANG MAI Urban Flooding GeoNode platform `_. - -This dataset contains an orthorectified image stored as RGBa GeoTiff with 4 bands, -three bands for the RGB and one for transparency (the alpha channel). - -Calling the gdalinfo command to see detailed information: - -.. code-block:: shell - - gdalinfo chiangMai_ortho.tif - -It will produce the following results: - -.. code-block:: shell - - Driver: GTiff/GeoTIFF - Files: chiangMai_ortho.tif - Size is 63203, 66211 - Coordinate System is: - PROJCS["WGS 84 / UTM zone 47N", - GEOGCS["WGS 84", - DATUM["WGS_1984", - SPHEROID["WGS 84",6378137,298.257223563, - AUTHORITY["EPSG","7030"]], - AUTHORITY["EPSG","6326"]], - PRIMEM["Greenwich",0, - AUTHORITY["EPSG","8901"]], - UNIT["degree",0.0174532925199433, - AUTHORITY["EPSG","9122"]], - AUTHORITY["EPSG","4326"]], - PROJECTION["Transverse_Mercator"], - PARAMETER["latitude_of_origin",0], - PARAMETER["central_meridian",99], - PARAMETER["scale_factor",0.9996], - PARAMETER["false_easting",500000], - PARAMETER["false_northing",0], - UNIT["metre",1, - AUTHORITY["EPSG","9001"]], - AXIS["Easting",EAST], - AXIS["Northing",NORTH], - AUTHORITY["EPSG","32647"]] - Origin = (487068.774750000040513,2057413.889810000080615) - Pixel Size = (0.028850000000000,-0.028850000000000) - Metadata: - AREA_OR_POINT=Area - TIFFTAG_SOFTWARE=pix4dmapper - Image Structure Metadata: - COMPRESSION=LZW - INTERLEAVE=PIXEL - Corner Coordinates: - Upper Left ( 487068.775, 2057413.890) ( 98d52'38.72"E, 18d36'27.34"N) - Lower Left ( 487068.775, 2055503.702) ( 98d52'38.77"E, 18d35'25.19"N) - Upper Right ( 488892.181, 2057413.890) ( 98d53'40.94"E, 18d36'27.38"N) - Lower Right ( 488892.181, 2055503.702) ( 98d53'40.98"E, 18d35'25.22"N) - Center ( 487980.478, 2056458.796) ( 98d53' 9.85"E, 18d35'56.28"N) - Band 1 Block=63203x1 Type=Byte, ColorInterp=Red - NoData Value=-10000 - Mask Flags: PER_DATASET ALPHA - Band 2 Block=63203x1 Type=Byte, ColorInterp=Green - NoData Value=-10000 - Mask Flags: PER_DATASET ALPHA - Band 3 Block=63203x1 Type=Byte, ColorInterp=Blue - NoData Value=-10000 - Mask Flags: PER_DATASET ALPHA - Band 4 Block=63203x1 Type=Byte, ColorInterp=Alpha - NoData Value=-10000 - -As you can see, this GeoTiff has not been tiled. For accessing subsets though, tiling can make a difference. With tiling, data are stored and compressed in blocks (tiled) rather than line by line (stripped). - -In the command output above it is visible that each band has blocks with the same width of the image (63203) and a unit length. The grids in the picture below show an image with equally sized tiles (left) and the same number of strips (right). To read data from the red subset, the intersected area will have to be decompressed. - - .. figure:: img/tiled_vs_stripped.png - :align: center - -In the tiled image we will have to decompress only 16 tiles, whereas in the stripped image on the right we’ll have to decompress many more strips. - -Drone images data usually have a stripped structure so, in most cases, they need to be optimized to increase performances. - -Let’s take a look at the gdal_translate command used to optimize our GeoTiff: - -.. code-block:: shell - - gdal_translate -co TILED=YES -co COMPRESS=JPEG -co PHOTOMETRIC=YCBCR - --config GDAL_TIFF_INTERNAL_MASK YES -b 1 -b 2 -b 3 -mask 4 - chiangMai_ortho.tif - chiangMai_ortho_optimized.tif - -.. note:: For the details about the command parameters see https://geoserver.geo-solutions.it/edu/en/raster_data/advanced_gdal/example5.html - -Once the process ended, call the gdalinfo command on the resulting tif file: - -.. code-block:: shell - - gdalinfo chiangMai_ortho_optimized.tif - -The following should be the results: - -.. code-block:: shell - - Driver: GTiff/GeoTIFF - Files: chiangMai_ortho_optimized.tif - Size is 63203, 66211 - Coordinate System is: - PROJCS["WGS 84 / UTM zone 47N", - GEOGCS["WGS 84", - DATUM["WGS_1984", - SPHEROID["WGS 84",6378137,298.257223563, - AUTHORITY["EPSG","7030"]], - AUTHORITY["EPSG","6326"]], - PRIMEM["Greenwich",0, - AUTHORITY["EPSG","8901"]], - UNIT["degree",0.0174532925199433, - AUTHORITY["EPSG","9122"]], - AUTHORITY["EPSG","4326"]], - PROJECTION["Transverse_Mercator"], - PARAMETER["latitude_of_origin",0], - PARAMETER["central_meridian",99], - PARAMETER["scale_factor",0.9996], - PARAMETER["false_easting",500000], - PARAMETER["false_northing",0], - UNIT["metre",1, - AUTHORITY["EPSG","9001"]], - AXIS["Easting",EAST], - AXIS["Northing",NORTH], - AUTHORITY["EPSG","32647"]] - Origin = (487068.774750000040513,2057413.889810000080615) - Pixel Size = (0.028850000000000,-0.028850000000000) - Metadata: - AREA_OR_POINT=Area - TIFFTAG_SOFTWARE=pix4dmapper - Image Structure Metadata: - COMPRESSION=YCbCr JPEG - INTERLEAVE=PIXEL - SOURCE_COLOR_SPACE=YCbCr - Corner Coordinates: - Upper Left ( 487068.775, 2057413.890) ( 98d52'38.72"E, 18d36'27.34"N) - Lower Left ( 487068.775, 2055503.702) ( 98d52'38.77"E, 18d35'25.19"N) - Upper Right ( 488892.181, 2057413.890) ( 98d53'40.94"E, 18d36'27.38"N) - Lower Right ( 488892.181, 2055503.702) ( 98d53'40.98"E, 18d35'25.22"N) - Center ( 487980.478, 2056458.796) ( 98d53' 9.85"E, 18d35'56.28"N) - Band 1 Block=256x256 Type=Byte, ColorInterp=Red - NoData Value=-10000 - Mask Flags: PER_DATASET - Band 2 Block=256x256 Type=Byte, ColorInterp=Green - NoData Value=-10000 - Mask Flags: PER_DATASET - Band 3 Block=256x256 Type=Byte, ColorInterp=Blue - NoData Value=-10000 - Mask Flags: PER_DATASET - -Our GeoTiff is now tiled with 256x256 tiles, has 3 bands and a 1-bit mask for nodata. - -We can also add internal overviews to the file using the gdaladdo command: - -.. code-block:: shell - - gdaladdo -r average chiangMai_ortho_optimized.tif 2 4 8 16 32 64 128 256 512 - -Overviews are duplicate versions of your original data, but resampled to a lower resolution, they can also be compressed with various algorithms, much in the same way as the original dataset. - -By default, overviews take the same compression type and transparency masks of the input dataset (applied through the gdal_translate command), so the parameters to be specified are: - - * :guilabel:`-r average`: computes the average of all non-NODATA contributing pixels - * :guilabel:`2 4 8 16 32 64 128 256 512`: the list of integral overview levels to build (from gdal version 2.3 levels are no longer required to build overviews) - -Calling the gdalinfo command again: - -.. code-block:: shell - - gdalinfo chiangMai_ortho_optimized.tif - -It results in: - -.. code-block:: shell - - Driver: GTiff/GeoTIFF - Files: chiangMai_ortho_optimized.tif - Size is 63203, 66211 - Coordinate System is: - PROJCS["WGS 84 / UTM zone 47N", - GEOGCS["WGS 84", - DATUM["WGS_1984", - SPHEROID["WGS 84",6378137,298.257223563, - AUTHORITY["EPSG","7030"]], - AUTHORITY["EPSG","6326"]], - PRIMEM["Greenwich",0, - AUTHORITY["EPSG","8901"]], - UNIT["degree",0.0174532925199433, - AUTHORITY["EPSG","9122"]], - AUTHORITY["EPSG","4326"]], - PROJECTION["Transverse_Mercator"], - PARAMETER["latitude_of_origin",0], - PARAMETER["central_meridian",99], - PARAMETER["scale_factor",0.9996], - PARAMETER["false_easting",500000], - PARAMETER["false_northing",0], - UNIT["metre",1, - AUTHORITY["EPSG","9001"]], - AXIS["Easting",EAST], - AXIS["Northing",NORTH], - AUTHORITY["EPSG","32647"]] - Origin = (487068.774750000040513,2057413.889810000080615) - Pixel Size = (0.028850000000000,-0.028850000000000) - Metadata: - AREA_OR_POINT=Area - TIFFTAG_SOFTWARE=pix4dmapper - Image Structure Metadata: - COMPRESSION=YCbCr JPEG - INTERLEAVE=PIXEL - SOURCE_COLOR_SPACE=YCbCr - Corner Coordinates: - Upper Left ( 487068.775, 2057413.890) ( 98d52'38.72"E, 18d36'27.34"N) - Lower Left ( 487068.775, 2055503.702) ( 98d52'38.77"E, 18d35'25.19"N) - Upper Right ( 488892.181, 2057413.890) ( 98d53'40.94"E, 18d36'27.38"N) - Lower Right ( 488892.181, 2055503.702) ( 98d53'40.98"E, 18d35'25.22"N) - Center ( 487980.478, 2056458.796) ( 98d53' 9.85"E, 18d35'56.28"N) - Band 1 Block=256x256 Type=Byte, ColorInterp=Red - NoData Value=-10000 - Overviews: 31602x33106, 15801x16553, 7901x8277, 3951x4139, 1976x2070, 988x1035, 494x518, 247x259, 124x130 - Mask Flags: PER_DATASET - Overviews of mask band: 31602x33106, 15801x16553, 7901x8277, 3951x4139, 1976x2070, 988x1035, 494x518, 247x259, 124x130 - Band 2 Block=256x256 Type=Byte, ColorInterp=Green - NoData Value=-10000 - Overviews: 31602x33106, 15801x16553, 7901x8277, 3951x4139, 1976x2070, 988x1035, 494x518, 247x259, 124x130 - Mask Flags: PER_DATASET - Overviews of mask band: 31602x3Results in:3106, 15801x16553, 7901x8277, 3951x4139, 1976x2070, 988x1035, 494x518, 247x259, 124x130 - Band 3 Block=256x256 Type=Byte, ColorInterp=Blue - NoData Value=-10000 - Overviews: 31602x33106, 15801x16553, 7901x8277, 3951x4139, 1976x2070, 988x1035, 494x518, 247x259, 124x130 - Mask Flags: PER_DATASET - Overviews of mask band: 31602x33106, 15801x16553, 7901x8277, 3951x4139, 1976x2070, 988x1035, 494x518, 247x259, 124x130 - -Notice that the transparency masks of internal overviews have been applied (their compression does not show up in the file metadata). - -UAVs usually provide also two other types of data: ``DTM (Digital Terrain Model)`` and ``DSM (Digital Surface Model)``. - -Those data require different processes to be optimized. Let’s look at some examples to better understand how to use gdal to accomplish that task. - -From the `CHIANG MAI Urban Flooding GeoNode platform `_ platform it is currently available the ``chiangMai_dtm_optimized`` layer, -let’s download its original dataset. - -This dataset should contain the DTM file ``chiangMai_dtm.tif``. - -Calling the gdalinfo command on it: - -.. code-block:: shell - - gdalinfo chiangMai_dtm.tif - -The following information will be displayed: - -.. code-block:: shell - - Driver: GTiff/GeoTIFF - Files: chiangMai_dtm.tif - Size is 12638, 13240 - Coordinate System is: - PROJCS["WGS 84 / UTM zone 47N", - GEOGCS["WGS 84", - DATUM["WGS_1984", - SPHEROID["WGS 84",6378137,298.257223563, - AUTHORITY["EPSG","7030"]], - AUTHORITY["EPSG","6326"]], - PRIMEM["Greenwich",0, - AUTHORITY["EPSG","8901"]], - UNIT["degree",0.0174532925199433, - AUTHORITY["EPSG","9122"]], - AUTHORITY["EPSG","4326"]], - PROJECTION["Transverse_Mercator"], - PARAMETER["latitude_of_origin",0], - PARAMETER["central_meridian",99], - PARAMETER["scale_factor",0.9996], - PARAMETER["false_easting",500000], - PARAMETER["false_northing",0], - UNIT["metre",1, - AUTHORITY["EPSG","9001"]], - AXIS["Easting",EAST], - AXIS["Northing",NORTH], - AUTHORITY["EPSG","32647"]] - Origin = (487068.774750000040513,2057413.889810000080615) - Pixel Size = (0.144270000000000,-0.144270000000000) - Metadata: - AREA_OR_POINT=Area - TIFFTAG_SOFTWARE=pix4dmapper - Image Structure Metadata: - COMPRESSION=LZW - INTERLEAVE=BAND - Corner Coordinates: - Upper Left ( 487068.775, 2057413.890) ( 98d52'38.72"E, 18d36'27.34"N) - Lower Left ( 487068.775, 2055503.755) ( 98d52'38.77"E, 18d35'25.19"N) - Upper Right ( 488892.059, 2057413.890) ( 98d53'40.94"E, 18d36'27.37"N) - Lower Right ( 488892.059, 2055503.755) ( 98d53'40.98"E, 18d35'25.22"N) - Center ( 487980.417, 2056458.822) ( 98d53' 9.85"E, 18d35'56.28"N) - Band 1 Block=12638x1 Type=Float32, ColorInterp=Gray - NoData Value=-10000 - -Reading this image could be very slow because it has not been tiled yet. So, as discussed above, its data need to be stored and compressed in tiles to increase performances. - -The following gdal_translate command should be appropriate for that purpose: - -.. code-block:: shell - - gdal_translate -co TILED=YES -co COMPRESS=DEFLATE chiangMai_dtm.tif chiangMai_dtm_optimized.tif - -When the data to compress consists of imagery (es. aerial photographs, true-color satellite images, or colored maps) you can use lossy algorithms such as JPEG. We are now compressing data where the precision is important, the band data type is Float32 and elevation values should not be altered, so a lossy algorithm such as JPEG is not suitable. JPEG should generally only be used with Byte data (8 bit per channel) so we have choosen the lossless DEFLATE compression through the COMPRESS=DEFLATE creation option. - -Calling the gdalinfo command again: - -.. code-block:: shell - - gdalinfo chiangMai_dtm_optimized.tif - -We can observe the following results: - -.. code-block:: shell - - Driver: GTiff/GeoTIFF - Files: chiangMai_dtm_optimized.tif - Size is 12638, 13240 - Coordinate System is: - PROJCS["WGS 84 / UTM zone 47N", - GEOGCS["WGS 84", - DATUM["WGS_1984", - SPHEROID["WGS 84",6378137,298.257223563, - AUTHORITY["EPSG","7030"]], - AUTHORITY["EPSG","6326"]], - PRIMEM["Greenwich",0, - AUTHORITY["EPSG","8901"]], - UNIT["degree",0.0174532925199433, - AUTHORITY["EPSG","9122"]], - AUTHORITY["EPSG","4326"]], - PROJECTION["Transverse_Mercator"], - PARAMETER["latitude_of_origin",0], - PARAMETER["central_meridian",99], - PARAMETER["scale_factor",0.9996], - PARAMETER["false_easting",500000], - PARAMETER["false_northing",0], - UNIT["metre",1, - AUTHORITY["EPSG","9001"]], - AXIS["Easting",EAST], - AXIS["Northing",NORTH], - AUTHORITY["EPSG","32647"]] - Origin = (487068.774750000040513,2057413.889810000080615) - Pixel Size = (0.144270000000000,-0.144270000000000) - Metadata: - AREA_OR_POINT=Area - TIFFTAG_SOFTWARE=pix4dmapper - Image Structure Metadata: - COMPRESSION=DEFLATE - INTERLEAVE=BAND - Corner Coordinates: - Upper Left ( 487068.775, 2057413.890) ( 98d52'38.72"E, 18d36'27.34"N) - Lower Left ( 487068.775, 2055503.755) ( 98d52'38.77"E, 18d35'25.19"N) - Upper Right ( 488892.059, 2057413.890) ( 98d53'40.94"E, 18d36'27.37"N) - Lower Right ( 488892.059, 2055503.755) ( 98d53'40.98"E, 18d35'25.22"N) - Center ( 487980.417, 2056458.822) ( 98d53' 9.85"E, 18d35'56.28"N) - Band 1 Block=256x256 Type=Float32, ColorInterp=Gray - NoData Value=-10000 - -We need also to create overviews through the gdaladdo command: - -.. code-block:: shell - - gdaladdo -r nearest chiangMai_dtm_optimized.tif 2 4 8 16 32 64 - -Unlike the previous example, overviews will be created with the **nearest resampling algorithm**. That is due to the nature of the data we are representing: we should not consider the average between two elevation values but simply the closer one, it is more reliable regarding the conservation of the original data. - -Calling the gdalinfo command again: - -.. code-block:: shell - - gdalinfo chiangMai_dtm_optimized.tif - -We can see the following information: - -.. code-block:: shell - - Driver: GTiff/GeoTIFF - Files: chiangMai_dtm_optimized.tif - Size is 12638, 13240 - Coordinate System is: - PROJCS["WGS 84 / UTM zone 47N", - GEOGCS["WGS 84", - DATUM["WGS_1984", - SPHEROID["WGS 84",6378137,298.257223563, - AUTHORITY["EPSG","7030"]], - AUTHORITY["EPSG","6326"]], - PRIMEM["Greenwich",0, - AUTHORITY["EPSG","8901"]], - UNIT["degree",0.0174532925199433, - AUTHORITY["EPSG","9122"]], - AUTHORITY["EPSG","4326"]], - PROJECTION["Transverse_Mercator"], - PARAMETER["latitude_of_origin",0], - PARAMETER["central_meridian",99], - PARAMETER["scale_factor",0.9996], - PARAMETER["false_easting",500000], - PARAMETER["false_northing",0], - UNIT["metre",1, - AUTHORITY["EPSG","9001"]], - AXIS["Easting",EAST], - AXIS["Northing",NORTH], - AUTHORITY["EPSG","32647"]] - Origin = (487068.774750000040513,2057413.889810000080615) - Pixel Size = (0.144270000000000,-0.144270000000000) - Metadata: - AREA_OR_POINT=Area - TIFFTAG_SOFTWARE=pix4dmapper - Image Structure Metadata: - COMPRESSION=DEFLATE - INTERLEAVE=BAND - Corner Coordinates: - Upper Left ( 487068.775, 2057413.890) ( 98d52'38.72"E, 18d36'27.34"N) - Lower Left ( 487068.775, 2055503.755) ( 98d52'38.77"E, 18d35'25.19"N) - Upper Right ( 488892.059, 2057413.890) ( 98d53'40.94"E, 18d36'27.37"N) - Lower Right ( 488892.059, 2055503.755) ( 98d53'40.98"E, 18d35'25.22"N) - Center ( 487980.417, 2056458.822) ( 98d53' 9.85"E, 18d35'56.28"N) - Band 1 Block=256x256 Type=Float32, ColorInterp=Gray - NoData Value=-10000 - Overviews: 6319x6620, 3160x3310, 1580x1655, 790x828, 395x414, 198x207 - -Overviews have been created. By default, they inherit the same compression type of the original dataset (there is no evidence of it in the gdalinfo output). - -Other Raster Data Use Cases -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -* `Serving a large number of GrayScale GeoTiff with Palette `_ -* `Serving a large number of DTM ASCII Grid Files `_ -* `Serving a large number of Cartographic Black/White GeoTiff with Palette `_ -* `Serving a large number of satellite/aerial RGB GeoTiff with compression `_ -* `Optimizing and serving UAV data `_ -* `Optimizing and serving 16-bits satellite/aerial RGB GeoTiff `_ - -Process Raster Datasets Programmatically -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -In this section we will provide a set of :guilabel:`shell` scripts which might be very useful to batch process a lot of raster datasets programmatically. - -1. ``process_gray.sh`` - - .. code-block:: shell - - for filename in *.tif*; do echo gdal_translate -co TILED=YES -co COMPRESS=DEFLATE $filename ${filename//.tif/.optimized.tif}; done > gdal_translate.sh - chmod +x gdal_translate.sh - ./gdal_translate.sh - - .. code-block:: shell - - for filename in *.optimized.tif*; do echo gdaladdo -r nearest $filename 2 4 8 16 32 64 128 256 512; done > gdaladdo.sh - for filename in *.optimized.tif*; do echo mv \"$filename\" \"${filename//.optimized.tif/.tif}\"; done > rename.sh - chmod +x *.sh - ./gdaladdo.sh - ./rename.sh - -2. ``process_rgb.sh`` - - .. code-block:: shell - - for filename in *.tif*; do echo gdal_translate -co TILED=YES -co COMPRESS=JPEG -co PHOTOMETRIC=YCBCR -b 1 -b 2 -b 3 $filename ${filename//.tif/.optimized.tif}; done > gdal_translate.sh - chmod +x gdal_translate.sh - ./gdal_translate.sh - - .. code-block:: shell - - for filename in *.optimized.tif*; do echo gdaladdo -r average $filename 2 4 8 16 32 64 128 256 512; done > gdaladdo.sh - for filename in *.optimized.tif*; do echo mv \"$filename\" \"${filename//.optimized.tif/.tif}\"; done > rename.sh - chmod +x *.sh - ./gdaladdo.sh - ./rename.sh - -3. ``process_rgb_alpha.sh`` - - .. code-block:: shell - - for filename in *.tif*; do echo gdal_translate -co TILED=YES -co COMPRESS=JPEG -co PHOTOMETRIC=YCBCR --config GDAL_TIFF_INTERNAL_MASK YES -b 1 -b 2 -b 3 -mask 4 $filename ${filename//.tif/.optimized.tif}; done > gdal_translate.sh - chmod +x gdal_translate.sh - ./gdal_translate.sh - - .. code-block:: shell - - for filename in *.optimized.tif*; do echo gdaladdo -r average $filename 2 4 8 16 32 64 128 256 512; done > gdaladdo.sh - for filename in *.optimized.tif*; do echo mv \"$filename\" \"${filename//.optimized.tif/.tif}\"; done > rename.sh - chmod +x *.sh - ./gdaladdo.sh - ./rename.sh - -4. ``process_rgb_palette.sh`` - - .. code-block:: shell - - for filename in *.tif*; do echo gdal_translate -co TILED=YES -co COMPRESS=DEFLATE $filename ${filename//.tif/.optimized.tif}; done > gdal_translate.sh - chmod +x gdal_translate.sh - ./gdal_translate.sh - - .. code-block:: shell - - for filename in *.optimized.tif*; do echo gdaladdo -r average $filename 2 4 8 16 32 64 128 256 512; done > gdaladdo.sh - for filename in *.optimized.tif*; do echo mv \"$filename\" \"${filename//.optimized.tif/.tif}\"; done > rename.sh - chmod +x *.sh - ./gdaladdo.sh - ./rename.sh - -.. _createsuperuser: - -Create Users and Super Users -============================ - -Your first step will be to create a user. There are three options to do so, depending on which kind of user you want to create you may -choose a different option. We will start with creating a *superuser*, because this user is the most important. A superuser -has all the permissions without explicitly assigning them. - -The easiest way to create a superuser (in linux) is to open your terminal and type: - - .. code-block:: shell - - $ DJANGO_SETTINGS_MODULE=geonode.settings python manage.py createsuperuser - - .. note:: If you enabled ``local_settings.py`` the command will change as following: - - .. code-block:: shell - - $ DJANGO_SETTINGS_MODULE=geonode.local_settings python manage.py createsuperuser - -You will be asked a username (in this tutorial we will call the superuser you now create *your_superuser*), an email address and a password. - -Now you've created a superuser you should become familiar with the *Django Admin Interface*. As a superuser you are having -access to this interface, where you can manage users, layers, permission and more. To learn more detailed about this interface -check this LINK. For now it will be enough to just follow the steps. To attend the *Django Admin Interface*, go to your geonode website and *sign in* with *your_superuser*. Once you've logged in, the name of your user will appear on the top right. Click on it and the following menu -will show up: - - .. figure:: img/menu_admin.png - :align: center - - -Clicking on *Admin* causes the interface to show up. - - .. figure:: img/admin_interface.png - :align: center - -Go to *Auth* -> *Users* and you will see all the users that exist at the moment. In your case it will only be *your_superuser*. Click on it, and you will see a section on *Personal Info*, one on *Permissions* and one on *Important dates*. For the moment, the section on *Permissions* is the most important. - - .. figure:: img/permissions_django_admin.png - :align: center - -As you can see, there are three boxes that can be checked and unchecked. Because you've created a superuser, all three boxes -are checked as default. If only the box *active* would have been checked, the user would not be a superuser and would not be able to -access the *Django Admin Interface* (which is only available for users with the *staff* status). Therefore keep the following -two things in mind: - -* a superuser is able to access the *Django Admin Interface* and he has all permissions on the data uploaded to GeoNode. -* an ordinary user (created from the GeoNode interface) only has *active* permissions by default. The user will not have the ability to access the *Django Admin Interface* and certain permissions have to be added for him. - -Until now we've only created superusers. So how do you create an ordinary user? You have two options: - -#. Django Admin Interface - - First we will create a user via the *Django Admin Interface* because we've still got it open. Therefore go back to *Auth* -> *Users* and you should find a button on the right that says *Add user*. - - .. figure:: img/add_user.png - :align: center - - Click on it and a form to fill out will appear. Name the new user test_user, choose a password and click *save* at the right bottom of the site. - - .. figure:: img/add_test_user.png - :align: center - - Now you should be directed to the site where you could - change the permissions on the user *test_user*. As default only *active* is checked. If you want this user also to be able to attend this admin interface - you could also check *staff status*. But for now we leave the settings as they are! - - .. todo:: groups and permissions! - - To test whether the new user was successfully created, go back to the GeoNode web page and try to sign in. - -#. GeoNode website - - To create an ordinary user you could also just use the GeoNode website. If you installed GeoNode using a release, you should - see a *Register* button on the top, beside the *Sign in* button (you might have to log out before). - - .. figure:: img/register.png - :align: center - - Hit the button and again a form will appear for you to fill out. This user will be named *geonode_user* - - .. figure:: img/sign_up_test_user.png - :align: center - - .. todo:: NEW IMAGE WITH GEONODE USER! - - By hitting *Sign up* the user will be signed up, as default only with the status *active*. - -.. _batch_sync_permissions: - -Batch Sync Permissions -====================== - -GeoNode provides a very useful management command ``set_layers_permisions`` allowing an administrator to easily add / remove permissions to groups and users on one or more layers. - -The ``set_layers_permisions`` command arguments are: - -- **permissions** to set/unset --> read (r), write (w), download (d), owner (o) - - .. code-block:: python - - READ_PERMISSIONS = [ - 'view_resourcebase' - ] - WRITE_PERMISSIONS = [ - 'change_layer_data', - 'change_layer_style', - 'change_resourcebase_metadata' - ] - DOWNLOAD_PERMISSIONS = [ - 'download_resourcebase' - ] - OWNER_PERMISSIONS = [ - 'change_resourcebase', - 'delete_resourcebase', - 'change_resourcebase_permissions', - 'publish_resourcebase' - ] - -- **resources** (layers) which permissions will be assigned on --> type the layer title (use quotation mark for titles with white space), multiple choices can be typed with white space separator, if no titles are provided all the layers will be considered -- **users** who permissions will be assigned to, multiple choices can be typed with a white space separator -- **groups** who permissions will be assigned to, multiple choices can be typed with a white space separator -- **delete** flag (optional) which means the permissions will be unset - -Usage examples: ---------------- - -1. Assign **write** permissions on the layers **layer_X** and **layer Y** to the users **user_A** and **user_B** and to the group **group_C**. - - .. code-block:: shell - - python manage.py set_layers-permissions -p write -u user_A user_B -g group_C -r layer_X 'layer Y' - -2. Assign **owner** permissions on all the layers to the group **group_C**. - - .. code-block:: shell - - python manage.py set_layers-permissions -p owner -g group_C - -3. Unset **download** permissions on the layer **layer_X** for the user **user_A**. - - .. code-block:: shell - - python manage.py set_layers-permissions -p download -u user_A -r layer_X -d - -The same functionalities, with some limitations, are available also from the :guilabel:`Admin Dashboard >> Layers`. - -.. figure:: img/layer_batch_perms_admin.png - :align: center - -An action named :guilabel:`Set layers permissions` is available from the list, redirecting the administrator to a form to set / unset read, write, download and ownership permissions on the selected layers. - -.. figure:: img/layer_batch_perms_form.png - :align: center diff --git a/docs/admin/thesaurus/img/thesaurus_filter.png b/docs/admin/thesaurus/img/thesaurus_filter.png deleted file mode 100644 index f693f2eb7f7..00000000000 Binary files a/docs/admin/thesaurus/img/thesaurus_filter.png and /dev/null differ diff --git a/docs/admin/thesaurus/index.rst b/docs/admin/thesaurus/index.rst deleted file mode 100644 index b650f9aee97..00000000000 --- a/docs/admin/thesaurus/index.rst +++ /dev/null @@ -1,63 +0,0 @@ -Loading a thesaurus -=================== - -You can add a thesaurus into you GeoNode using the ``load_thesaurus`` command: - -.. code-block:: shell - - python manage.py load_thesaurus --help - - -d, --dry-run Only parse and print the thesaurus file, without perform insertion in the DB. - --name=NAME Identifier name for the thesaurus in this GeoNode instance. - --file=FILE Full path to a thesaurus in RDF format. - -In order add the inspire-themes thesaurus into a geonode instance, download it as file ``inspire-theme.rdf`` with the command: - -.. code-block:: shell - - wget -O inspire-theme.rdf https://raw.githubusercontent.com/geonetwork/core-geonetwork/master/web/src/test/resources/thesaurus/external/thesauri/theme/httpinspireeceuropaeutheme-theme.rdf - -and then issue the command: - -.. code-block:: shell - - python manage.py load_thesaurus --file inspire-theme.rdf --name inspire_themes - -The ``name`` is the identifier you'll use to refer to this thesaurus in your GeoNode instance. - - -If you only want to make sure that a thesaurus file will be properly parsed, give the ``--dry-run`` parameter, so that nothing wil be added to the DB. - -*Note*: if the ``name`` starts with the string ``fake``, the file will not be accessed at all, and some test keywords will be added to a fake new thesaurus. In this case the ``dry-run`` param will not be used. - - -Configure a thesaurus in GeoNode -================================ - -After you loaded a thesaurus into GeoNode, it should be configured in the ``settings.py`` file (or in the ``local_settings``) in this way: - -.. code-block:: shell - - THESAURUS = {'name':'THESAURUS NAME', 'required':True|False, 'filter':True|False,} - -- ``name``: (mandatory string) the identifier you used in the ``load_thesaurus`` commands. -- ``required``: (optional boolean) if ``True``, a keyword of this thesaurus is mandatory to complete the metadata. *Currently not implemented.* -- ``filter``: (optional boolean) if ``True``, a faceted list of keywords of this thesaurus will be presented on the search page. - -So, in order to set up the INSPIRE themes thesaurus you may set the THESAURUS value as: - -.. code-block:: shell - - THESAURUS = {'name': 'inspire_themes', 'required': True, 'filter': True} - -Apply a thesaurus to a resource -=============================== - -After you've finished the setup you should find a new input widget in each resource metadata wizard allowing you to choose a thesaurus for your resource. - -After applying a thesaurus to resources those should be listed in the filter section in GeoNodes resource list views. - -.. figure:: ./img/thesaurus_filter.png - :align: center - :width: 350px - :alt: thesauarus diff --git a/docs/admin/upgrade/index.rst b/docs/admin/upgrade/index.rst deleted file mode 100644 index 4bf4be5eff0..00000000000 --- a/docs/admin/upgrade/index.rst +++ /dev/null @@ -1,129 +0,0 @@ -Upgrade from 2.8.x -================== - - - -Upgrade from 2.7.x -================== - -Upgrade from 2.6.x -================== - -Upgrade from 2.4.x -================== - -These are the notes of a migration from 2.4.x to 2.10.1. -These notes could possibly works also when migrating from 2.6.x, 2.7.x, 2.8.x but were not tested in that scenarios. -You should run this procedure on your local machine and once you successfully migrated the database move the backup to your GeoNode 2.10.1 production instance. - -PostgreSQL ----------- - -Create a role and a database for Django GeoNode 2.4: - -.. code-block:: sql - - create role user with superuser login with password '***'; - create database gn_24 with owner user; - \c gn_24 - create extension postgis; - -Restore backup from your production backup: - -.. code-block:: shell - - psql gn_24 < gn_24.sql - -Run GeoNode migrations ----------------------- - -Activate your GeoNode virtualenv and set the env vars: - -.. code-block:: sql - - . env/bin/Activate - export vars_210 - -Here are the variables to export - update them to your environment settings: - -.. code-block:: shell - - export DATABASE_URL=postgis://user:***@localhost:5432/dbname - export DEFAULT_BACKEND_DATASTORE=data - export GEODATABASE_URL=postgis://user:***@localhost:5432/geonode_data - export ALLOWED_HOSTS="['localhost', '192.168.100.10']" - export STATIC_ROOT=~/www/geonode/static/ - export GEOSERVER_LOCATION=http://localhost:8080/geoserver/ - export GEOSERVER_PUBLIC_LOCATION=http://localhost:8080/geoserver/ - export GEOSERVER_ADMIN_PASSWORD=geoserver - export SESSION_EXPIRED_CONTROL_ENABLED=False - -Downgrade psycopg2: - -.. code-block:: shell - - pip install psycopg2==2.7.7 - -Apply migrations and apply basic fixtures: - -.. code-block:: shell - - cd wfp-geonode - ./manage.py migrate --fake-initial - paver sync - - -Regenerate from scratch the upload application tables in the database: - -.. code-block:: sql - - delete from django_migrations where app = 'upload'; - drop table upload_upload cascade; - drop table upload_uploadfile; - -Regenerate upload tables with migrate: - -.. code-block:: shell - - ./manage.py migrate upload - -Upgrade psycopg2: - -.. code-block:: shell - - pip install -r geonode/requirements.txt - -Create superuser ----------------- - -To create a superuser you should drop the following constraints (they can be re-enabled if needed): - -.. code-block:: sql - - alter table people_profile alter column last_login drop not null; - -.. code-block:: shell - - ./manage createsuperuser - -Fixes on database ------------------ - -For some reason some resources were unpublished: - -.. code-block:: sql - - UPDATE base_resourcebase SET is_published = true; - -Remove a foreign key from account_account which is not used anymore (GeoNode dev team: maybe even better let's remove all of the account tables, I think they are stale now): - -.. code-block:: sql - - ALTER TABLE account_account DROP CONSTRAINT user_id_refs_id_726cb6b4; - ALTER TABLE account_signupcode DROP CONSTRAINT "inviter_id_refs_id_49a7c0d9"; - -Fix the remote service layers by running this script: - -.. code-block:: shell - - python migration/fixes_remote_layers.py diff --git a/docs/advanced/components/img/google_ssl_001.png b/docs/advanced/components/img/google_ssl_001.png deleted file mode 100644 index 441b9902508..00000000000 Binary files a/docs/advanced/components/img/google_ssl_001.png and /dev/null differ diff --git a/docs/advanced/components/img/google_ssl_002.png b/docs/advanced/components/img/google_ssl_002.png deleted file mode 100644 index 4d5b22fe206..00000000000 Binary files a/docs/advanced/components/img/google_ssl_002.png and /dev/null differ diff --git a/docs/advanced/components/img/google_ssl_003.png b/docs/advanced/components/img/google_ssl_003.png deleted file mode 100644 index 95f7c7e7abe..00000000000 Binary files a/docs/advanced/components/img/google_ssl_003.png and /dev/null differ diff --git a/docs/advanced/components/img/google_ssl_004.png b/docs/advanced/components/img/google_ssl_004.png deleted file mode 100644 index 176ac67def7..00000000000 Binary files a/docs/advanced/components/img/google_ssl_004.png and /dev/null differ diff --git a/docs/advanced/components/img/google_ssl_005.png b/docs/advanced/components/img/google_ssl_005.png deleted file mode 100644 index 295a6c5a585..00000000000 Binary files a/docs/advanced/components/img/google_ssl_005.png and /dev/null differ diff --git a/docs/advanced/components/img/google_ssl_006.png b/docs/advanced/components/img/google_ssl_006.png deleted file mode 100644 index 8c6ad476993..00000000000 Binary files a/docs/advanced/components/img/google_ssl_006.png and /dev/null differ diff --git a/docs/advanced/components/img/google_ssl_007.png b/docs/advanced/components/img/google_ssl_007.png deleted file mode 100644 index aa773ef4731..00000000000 Binary files a/docs/advanced/components/img/google_ssl_007.png and /dev/null differ diff --git a/docs/advanced/components/img/google_ssl_008.png b/docs/advanced/components/img/google_ssl_008.png deleted file mode 100644 index 098efa08073..00000000000 Binary files a/docs/advanced/components/img/google_ssl_008.png and /dev/null differ diff --git a/docs/advanced/components/img/google_ssl_009.png b/docs/advanced/components/img/google_ssl_009.png deleted file mode 100644 index bd0f65f319c..00000000000 Binary files a/docs/advanced/components/img/google_ssl_009.png and /dev/null differ diff --git a/docs/advanced/components/img/google_ssl_010.png b/docs/advanced/components/img/google_ssl_010.png deleted file mode 100644 index 75cbb88b529..00000000000 Binary files a/docs/advanced/components/img/google_ssl_010.png and /dev/null differ diff --git a/docs/advanced/components/img/google_ssl_011.png b/docs/advanced/components/img/google_ssl_011.png deleted file mode 100644 index d14d21572b8..00000000000 Binary files a/docs/advanced/components/img/google_ssl_011.png and /dev/null differ diff --git a/docs/advanced/components/img/google_ssl_012.png b/docs/advanced/components/img/google_ssl_012.png deleted file mode 100644 index 266a8bebf45..00000000000 Binary files a/docs/advanced/components/img/google_ssl_012.png and /dev/null differ diff --git a/docs/advanced/components/img/google_ssl_013.png b/docs/advanced/components/img/google_ssl_013.png deleted file mode 100644 index eb63d508257..00000000000 Binary files a/docs/advanced/components/img/google_ssl_013.png and /dev/null differ diff --git a/docs/advanced/components/img/oauth001.png b/docs/advanced/components/img/oauth001.png deleted file mode 100644 index d1bb58e7c15..00000000000 Binary files a/docs/advanced/components/img/oauth001.png and /dev/null differ diff --git a/docs/advanced/components/img/oauth002.png b/docs/advanced/components/img/oauth002.png deleted file mode 100644 index 7daf9a47043..00000000000 Binary files a/docs/advanced/components/img/oauth002.png and /dev/null differ diff --git a/docs/advanced/components/img/oauth003.png b/docs/advanced/components/img/oauth003.png deleted file mode 100644 index bb962fee8eb..00000000000 Binary files a/docs/advanced/components/img/oauth003.png and /dev/null differ diff --git a/docs/advanced/components/img/oauth004.png b/docs/advanced/components/img/oauth004.png deleted file mode 100644 index 89853b5181d..00000000000 Binary files a/docs/advanced/components/img/oauth004.png and /dev/null differ diff --git a/docs/advanced/components/img/oauth005.png b/docs/advanced/components/img/oauth005.png deleted file mode 100644 index 24989a3dc0e..00000000000 Binary files a/docs/advanced/components/img/oauth005.png and /dev/null differ diff --git a/docs/advanced/components/img/oauth006.png b/docs/advanced/components/img/oauth006.png deleted file mode 100644 index a23155aaaa0..00000000000 Binary files a/docs/advanced/components/img/oauth006.png and /dev/null differ diff --git a/docs/advanced/components/img/oauth007.png b/docs/advanced/components/img/oauth007.png deleted file mode 100644 index 330960a1de1..00000000000 Binary files a/docs/advanced/components/img/oauth007.png and /dev/null differ diff --git a/docs/advanced/components/img/oauth008.png b/docs/advanced/components/img/oauth008.png deleted file mode 100644 index 73e6b99bada..00000000000 Binary files a/docs/advanced/components/img/oauth008.png and /dev/null differ diff --git a/docs/advanced/components/img/oauth009.png b/docs/advanced/components/img/oauth009.png deleted file mode 100644 index bb074dc8163..00000000000 Binary files a/docs/advanced/components/img/oauth009.png and /dev/null differ diff --git a/docs/advanced/components/img/oauth010.png b/docs/advanced/components/img/oauth010.png deleted file mode 100644 index d5e4cb77d1c..00000000000 Binary files a/docs/advanced/components/img/oauth010.png and /dev/null differ diff --git a/docs/advanced/components/img/oauth011.png b/docs/advanced/components/img/oauth011.png deleted file mode 100644 index e6f5a428aba..00000000000 Binary files a/docs/advanced/components/img/oauth011.png and /dev/null differ diff --git a/docs/advanced/components/img/oauth012.png b/docs/advanced/components/img/oauth012.png deleted file mode 100644 index a089ce21dfe..00000000000 Binary files a/docs/advanced/components/img/oauth012.png and /dev/null differ diff --git a/docs/advanced/components/img/oauth013.png b/docs/advanced/components/img/oauth013.png deleted file mode 100644 index a7027d05e93..00000000000 Binary files a/docs/advanced/components/img/oauth013.png and /dev/null differ diff --git a/docs/advanced/components/img/oauth014.png b/docs/advanced/components/img/oauth014.png deleted file mode 100644 index 422f255a518..00000000000 Binary files a/docs/advanced/components/img/oauth014.png and /dev/null differ diff --git a/docs/advanced/components/img/oauth015.png b/docs/advanced/components/img/oauth015.png deleted file mode 100644 index 27bac6ce342..00000000000 Binary files a/docs/advanced/components/img/oauth015.png and /dev/null differ diff --git a/docs/advanced/components/img/oauth016.png b/docs/advanced/components/img/oauth016.png deleted file mode 100644 index 72047628640..00000000000 Binary files a/docs/advanced/components/img/oauth016.png and /dev/null differ diff --git a/docs/advanced/components/img/oauth017.png b/docs/advanced/components/img/oauth017.png deleted file mode 100644 index f109f2aee63..00000000000 Binary files a/docs/advanced/components/img/oauth017.png and /dev/null differ diff --git a/docs/advanced/components/img/oauth018.png b/docs/advanced/components/img/oauth018.png deleted file mode 100644 index 7554bc1ab99..00000000000 Binary files a/docs/advanced/components/img/oauth018.png and /dev/null differ diff --git a/docs/advanced/components/img/oauth019.png b/docs/advanced/components/img/oauth019.png deleted file mode 100644 index 558a87f1bad..00000000000 Binary files a/docs/advanced/components/img/oauth019.png and /dev/null differ diff --git a/docs/advanced/components/img/oauth020.png b/docs/advanced/components/img/oauth020.png deleted file mode 100644 index f0782cf4a94..00000000000 Binary files a/docs/advanced/components/img/oauth020.png and /dev/null differ diff --git a/docs/advanced/components/img/oauth021.png b/docs/advanced/components/img/oauth021.png deleted file mode 100644 index 5a8d1302efc..00000000000 Binary files a/docs/advanced/components/img/oauth021.png and /dev/null differ diff --git a/docs/advanced/components/img/oauth022.png b/docs/advanced/components/img/oauth022.png deleted file mode 100644 index e2e72f05e93..00000000000 Binary files a/docs/advanced/components/img/oauth022.png and /dev/null differ diff --git a/docs/advanced/components/img/oauth023.png b/docs/advanced/components/img/oauth023.png deleted file mode 100644 index e4fe5d3d5b5..00000000000 Binary files a/docs/advanced/components/img/oauth023.png and /dev/null differ diff --git a/docs/advanced/components/img/oauth024.png b/docs/advanced/components/img/oauth024.png deleted file mode 100644 index 083f304ee65..00000000000 Binary files a/docs/advanced/components/img/oauth024.png and /dev/null differ diff --git a/docs/advanced/components/img/oauth025.png b/docs/advanced/components/img/oauth025.png deleted file mode 100644 index 885c2bf3825..00000000000 Binary files a/docs/advanced/components/img/oauth025.png and /dev/null differ diff --git a/docs/advanced/components/img/oauth026.png b/docs/advanced/components/img/oauth026.png deleted file mode 100644 index 10b2adf12bb..00000000000 Binary files a/docs/advanced/components/img/oauth026.png and /dev/null differ diff --git a/docs/advanced/components/img/oauth027.png b/docs/advanced/components/img/oauth027.png deleted file mode 100644 index 3774d38c89d..00000000000 Binary files a/docs/advanced/components/img/oauth027.png and /dev/null differ diff --git a/docs/advanced/components/img/oauth028.png b/docs/advanced/components/img/oauth028.png deleted file mode 100644 index e9407f6873b..00000000000 Binary files a/docs/advanced/components/img/oauth028.png and /dev/null differ diff --git a/docs/advanced/components/img/oauth029.png b/docs/advanced/components/img/oauth029.png deleted file mode 100644 index cd53d6202ae..00000000000 Binary files a/docs/advanced/components/img/oauth029.png and /dev/null differ diff --git a/docs/advanced/components/img/oauth030.png b/docs/advanced/components/img/oauth030.png deleted file mode 100644 index 363b2ff956a..00000000000 Binary files a/docs/advanced/components/img/oauth030.png and /dev/null differ diff --git a/docs/advanced/components/img/oauth031.png b/docs/advanced/components/img/oauth031.png deleted file mode 100644 index cbe55340590..00000000000 Binary files a/docs/advanced/components/img/oauth031.png and /dev/null differ diff --git a/docs/advanced/components/img/oauth032.png b/docs/advanced/components/img/oauth032.png deleted file mode 100644 index 816aa4ff050..00000000000 Binary files a/docs/advanced/components/img/oauth032.png and /dev/null differ diff --git a/docs/advanced/components/img/oauth033.png b/docs/advanced/components/img/oauth033.png deleted file mode 100644 index f1211ae3cfb..00000000000 Binary files a/docs/advanced/components/img/oauth033.png and /dev/null differ diff --git a/docs/advanced/components/index.rst b/docs/advanced/components/index.rst deleted file mode 100644 index 1ca16caa49c..00000000000 --- a/docs/advanced/components/index.rst +++ /dev/null @@ -1,1111 +0,0 @@ -Overview -======== - -**TODO*** - -Django -====== - -**TODO** - -WebServers -========== - -**TODO** - -Apache ------- - -**TODO** - -NGINX ------ - -**TODO** - -GeoServer -========= - -**TODO** - -Databases -========= - -**TODO** - -.. _geoserver_geonode_aa: - -OAuth2 Security: Authentication and Authorization -================================================= -GeoNode interacts with GeoServer through an advanced security mechanism based on OAuth2 Protocol and GeoFence. This section is a walk through of the configuration and setup of GeoNode and GeoServer Advanced Security. - -What we will see in this section is: - -* **Introduction** - -* **GeoNode** (Security Backend): - - #. DJango Authentication - - #. DJango OAuth Toolkit Setup and Configuration - - #. Details on ``settings.py`` Security Settings - -* **GeoServer** (Security Backend): - - #. GeoServer Security Subsystem - - #. Introduction to the GeoServer OAuth2 Security Plugin - - #. Configuration of the ``GeoNode REST Role Service`` - - #. Configuration of the ``GeoNode OAuth2 Authentication Filter`` - - #. The GeoServer Authentication Filter Chains - - #. Introduction to GeoFence Plugin, the Advanced Security Framework for GeoServer - -* **Throubleshooting and Advanced Features**: - - #. Common Issues and Fixes - - #. How to setup ``HTTPS`` secured endpoints - - #. GeoFence Advanced Features - -Introduction ------------- - -GeoServer, i.e. the geospatial backend server of GeoNode, is a sptial server which needs authenticated users in order to access protected resources or administration functions. - -GeoServer supports several kind of Authentication and Authorization mechanisms. Those systems are pluggable and GeoServer can use them at the same time by the use of a ``Filter Chain``. -Briefly this mechanism allows GeoServer to check for different A&A protocols one by one. The first one matching is used by GeoServer to authorize the users. - -GeoNode Authentication is based by default on Django Security Subsystem. Django authentication allows GeoNode to manage its internal users, groups, roles and sessions. - -GeoNode has some external components, like GeoServer or QGis Server, which are pluggable and stand-alone services, devoted to the management of geospatial data. -Those external services have theyr own authentication and authorization mechanisms which must be syncronized somehow with the GeoNode one. Also, those external services -maintain, in most of the cases and unless specific configuration does not disable this, alternative security access which for instance allow GeoNode to modify the geospatial catalog -under the hood, or a system administrator to have indipendent and priviliged access to the servers. - -Before going deeply on how GeoServer/GeoNode A&A works and how it can be configured in order to work correctly with GeoNode, lets quickly clarify the difference between the ``Authentication`` and ``Authorization`` concepts. - -Authentication -^^^^^^^^^^^^^^ - -Authentication is the process of verifying the identity of someone through the use of some sort of credentials and an handshake protocol. -If the credentials are valid, the authorization process starts. Authentication process always proceeds to Authorization process (although they may often seem to be combined). -The two terms are often used synonymously but they are two different processes. - -For more details and explanation about the authentication concepts, take a look `here `_. - -Authorization -^^^^^^^^^^^^^ - -Authorization is the process of allowing authenticated users to access protected resources by checking its roles and rights against some sort of security rules mechanism or protocol. -In other words it allows to control access rights by granting or denying specific permissions to specific authorized users. - -GeoNode Security Backend ------------------------- - -DJango Authentication -^^^^^^^^^^^^^^^^^^^^^ - -The Django authentication system handles both authentication and authorization. - -The auth system consists of: - -#. Users -#. Permissions: Binary (yes/no) flags designating whether a user may perform a certain task. -#. Groups: A generic way of applying labels and permissions to more than one user. -#. A configurable password hashing system -#. Forms and view tools for logging in users, or restricting content -#. A pluggable backend system - -The authentication system in Django aims to be very generic and doesn’t provide some features commonly found in web authentication systems. Solutions for some of these common problems have been implemented in third-party packages: - -#. Password strength checking -#. Throttling of login attempts -#. Authentication against third-parties (OAuth, for example) - -.. note:: For more details on installation and configuration of Django authentication system, please refer to the official guide https://docs.djangoproject.com/en/1.10/topics/auth/. - -GeoNode communicates with GeoServer through Basic Authentication under the hood, in order to configure the data and the GeoServer catalog. - -In order to do this, you must be sure that GeoNode knows the **internal** admin user and password of GeoServer. - -.. warning:: This must be an internal GeoServer user with admin rights, not a GeoNode one. - -Make sure the credentials are correctly configured into the file ``settings.py`` - -OGC_SERVER -^^^^^^^^^^ - -Ensure that the ``OGC_SERVER`` settings are correctly configured. - -Notice that the two properties ``LOGIN_ENDPOINT`` and ``LOGOUT_ENDPOINT`` must speficy the GeoServer OAuth2 Endpoints (see details below). -The default values ``'j_spring_oauth2_geonode_login'`` and ``'j_spring_oauth2_geonode_logout'`` work in most of the cases, unless you need some specific endpoints different from the latters. -In any case those values **must** be coherent with the GeoServer OAuth2 Plugin configuration. - -If in doubt, please use the default values here below. - -Default values are: - -.. code-block:: python - - ... - # OGC (WMS/WFS/WCS) Server Settings - # OGC (WMS/WFS/WCS) Server Settings - OGC_SERVER = { - 'default': { - 'BACKEND': 'geonode.geoserver', - 'LOCATION': GEOSERVER_LOCATION, - 'LOGIN_ENDPOINT': 'j_spring_oauth2_geonode_login', - 'LOGOUT_ENDPOINT': 'j_spring_oauth2_geonode_logout', - # PUBLIC_LOCATION needs to be kept like this because in dev mode - # the proxy won't work and the integration tests will fail - # the entire block has to be overridden in the local_settings - 'PUBLIC_LOCATION': GEOSERVER_PUBLIC_LOCATION, - 'USER': 'admin', - 'PASSWORD': 'geoserver', - 'MAPFISH_PRINT_ENABLED': True, - 'PRINT_NG_ENABLED': True, - 'GEONODE_SECURITY_ENABLED': True, - 'WMST_ENABLED': False, - 'BACKEND_WRITE_ENABLED': True, - 'WPS_ENABLED': False, - 'LOG_FILE': '%s/geoserver/data/logs/geoserver.log' % os.path.abspath(os.path.join(PROJECT_ROOT, os.pardir)), - # Set to name of database in DATABASES dictionary to enable - 'DATASTORE': '', # 'datastore', - 'TIMEOUT': 10 # number of seconds to allow for HTTP requests - } - } - ... - -GeoNode and GeoServer A&A Interaction -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The GeoServer instance used by GeoNode, has a perticular setup that allows the two frameworks to correctly interact and exchange informations on users credentials and permissions. - -In particular GeoServer is configured with a ``Filter Chain`` for Authorization that makes use of the two following protocols: - - #. **Basic Authentication**; this is the default GeoServer Authentication mechanism. This makes use of `rfc2617 - Basic and Digest Access Authentication `_ in order to check for user's credentials. - In other words, GeoServer takes a ``username`` and a ``password`` encoded `Base64 `_ on the HTTP Request Headers and compare them against its internal database (which by default is an encrypted XML file on the GeoServer Data Dir). - If the user's credentials match, then GeoServer checks for Authorization through its ``Role Services`` (we will see those services in details on the *GeoServer (Security Backend)* section below). - - .. note:: GeoServer ships by default with ``admin`` and ``geoserver`` as the default administrator user name and password. Before putting the GeoServer on-line it is imperative to change at least the administrator password. - - #. **OAuth2 Authentication**; this module allows GeoServer to authenticate against the `OAuth2 Protocol `_. If the Basic Authentication fails, GeoServer falls back to this by using GeoNode as OAuth2 Provider by default. - -.. note:: Further details can be found directly on the official GeoServer documentation at section "`Authentication Chain `_" - -From the **GeoNode backend (server) side**, the server will make use of **Basic Authentication** with administrator credentials to configure the GeoServer catalog. GeoServer must be reachable by GeoNode of course, and GeoNode must know the internal GeoServer admin credentials. - -From the **GeoNode frontend (browser and GUI) side**, the *Authentication* goal is to allow GeoServer to recognize as valid a user which has been already logged into GeoNode, providing kind of an `SSO `_ mechanism between the two applications. - -GeoServer must know and must be able to access GeoNode via HTTP/HTTPS. In other words, an external user connected to GeoNode must be authenticated to GeoServer with same permissions. This is possible through the **OAuth2 Authentication** Protocol. - -**GeoNode / GeoServer Authentication Mechanism** - - *GeoNode as OAuth2 Provider (OP)* - - OpenID Connect is an identity framework built on OAuth 2.0 protocol which extends the authorization of OAuth 2.0 processes to implement its authentication mechanism. OpenID Connect adds a discovery mechanism allowing users to use an external trusted authority as an identity provider. From another point of view, this can be seen as a single sign on (SSO) system. - - OAuth 2.0 is an authorization framework which is capable of providing a way for clients to access a resource with restricted access on behalf of the resource owner. OpenID Connect allows clients to verify the users with an authorization server based authentication. - - As an OP, GeoNode will be able to act as trusted identity provider, thus allowing the system working on an isolated environment and/or allow GeoNode to authenticate private users managed by the local DJango auth subsystem. - - *GeoServer as OAuth2 Relying Party (RP)* - - Thanks to the **OAuth2 Authentication** GeoServer is able to retrieve an end user's identity directly from the OAuth2 Provider (OP). - - With GeoNode acting as an OP, the mechanism will avoid the use of cookies relying, instead, on the OAuth2 secure protocol. - - How the OAuth2 Protocol works: - - .. figure:: img/oauth001.png - - 1. The relying party sends the request to the OAuth2 provider to authenticate the end user - - 2. The OAuth2 provider authenticates the user - - 3. The OAuth2 provider sends the ID token and access token to the relying party - - 4. The relying party sends a request to the user info endpoint with the access token received from OAuth2 provider - - 5. The user info endpoint returns the claims. - -**GeoNode / GeoServer Authorization Mechanism** - - Allowing GeoServer to make use of a OAuth2 in order to act as an OAuth2 RP, is not sufficient to map a user identity to its roles though. - - On GeoServer side we will still need to a ``RoleService`` which would be able to talk to GeoNode and transform the tokens into a User Principal to be used within the GeoServer Security subsystem itself. - - In other words after a successfull Authentication, GeoServer needs to Authorize the user in order to understand which resources he is enable to access or not. - A ``REST based RoleService`` on GeoNode side, allows GeoServer to talk to GeoNode via `REST `_ to get the current user along with the list of its Roles. - - Nevertheless knowning the Roles associated to a user is not sufficient. The complete GeoServer Authorization needs to catch a set of ``Access Rules``, associdated to the Roles, in order to establish which resources and data are accessible by the user. - - The GeoServer Authorization is based on Roles only, therefore for each authenticated user we need also to know: - - 1. The Roles associated to a valid user session - - 2. The access permissions associated to a GeoServer Resource - - The Authentication mechanism above allows GeoServer to get information about the user and his Roles, which addresses point 1. - - About point 2, GeoServer makes use of the `GeoFence Embedded Server `_ plugin. - GeoFence is a java web application that provides an advanced authentication / authorization engine for GeoServer using the interface described in `here `_. - GeoFence has its own rules database for the management of Authorization rules, and overrides the standard GeoServer security management system by implementing a sophisticated Resource Access Manager. - Least but not last, GeoFence implements and exposes a `REST API `_ allowing remote authorized clients to read / write / modify security rules. - - The advantages using such plugin are multiple: - - 1. The Authorizations rules have a fine granularity. The security rules are handled by GeoFence in a way similar to the iptables ones, and allow to define security constraints even on sub-regions and attributes of layers. - - 2. GeoFence exposes a REST interface to its internal rule database, allowing external managers to update the security constraints programmatically - - 3. GeoFence implements an internal caching mechanism which improves considerably the performances under load. - - *GeoNode interaction with GeoFence* - - GeoNode itself is able to push/manage Authorization rules to GeoServer through the GeoFence `REST API `_, acting as an administrator for GeoServer. - GeoNode properly configures the GeoFence rules anytime it is needed, i.e. the permissions of a Resource / Layer are updated. - -GeoServer must know and must be able to access GeoNode via HTTP/HTTPS. In other words, an external user connected to GeoNode must be authenticated to GeoServer with same permissions. This is possible through the **GeoNodeCoockieProcessingFiler**. - -Summarizing we will have different ways to access GeoNode Layers: - -#. Through GeoNode via DJango Authentication and **GeoNodeCoockieProcessingFiler**; basically the users available in GeoNode are also valid for GeoServer or any other backend. - - .. warning:: If a GeoNode user has "administrator" rights, he will be able to administer GeoServer too. - -#. Through GeoServer Security Subsystem; it will be always possible to access to GeoServer using its internal security system and users, unless explictly disabled (**warning** this is dangeruos, you must know what you are doing). - -Lets now see in details how the single pieces are configured and how they can be configured. - -DJango OAuth Toolkit Setup and Configuration -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -As stated above, GeoNode makes use of the OAuth2 protocol for all the frontend interactions with GeoServer. GeoNode must be conifgured as an OAuth2 Provider and provide a ``Client ID`` and a ``Client Sercret`` kayes to GeoServer. -This is possible by enabling and configuring the `Django OAuth Toolkit Plugin `_. - -.. warning:: GeoNode and GeoServer won't work at all if the follwing steps are not executed at the first installation. - -Default ``settings.py`` Security Settings for OAuth2 -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Double check that the OAuth2 Provider and Security Plugin is enabled and that the settings below are correctly configured. - -AUTH_IP_WHITELIST -^^^^^^^^^^^^^^^^^ - -``AUTH_IP_WHITELIST`` property limits access to users/groups REST Role Service endpoints to the only whitelisted IP addresses. Empty list means 'allow all'. -If you need to limit 'api' REST calls to only some specific IPs fill the list like this: ``AUTH_IP_WHITELIST = ['192.168.1.158', '192.168.1.159']`` - -Default values are: - -.. code-block:: python - - ... - AUTH_IP_WHITELIST = [] - ... - -INSTALLED_APPS -^^^^^^^^^^^^^^ - -In order to allow GeoNode to act as an OAuth2 Provider, we need to enable the ``oauth2_provider`` DJango application provided by the "Django OAuth Toolkit". - -Default values are: - -.. code-block:: python - - ... - INSTALLED_APPS = ( - - 'modeltranslation', - - ... - 'guardian', - 'oauth2_provider', - ... - - ) + GEONODE_APPS - ... - -MIDDLEWARE_CLASSES -^^^^^^^^^^^^^^^^^^ - -Installing the `oauth2_provider`` DJango application is not sufficient to enable the full functionality. We need also GeoNode to include additional entities to its internal model. - -Default values are: - -.. code-block:: python - - ... - MIDDLEWARE_CLASSES = ( - 'django.middleware.common.CommonMiddleware', - 'django.contrib.sessions.middleware.SessionMiddleware', - 'django.contrib.messages.middleware.MessageMiddleware', - - # The setting below makes it possible to serve different languages per - # user depending on things like headers in HTTP requests. - 'django.middleware.locale.LocaleMiddleware', - 'pagination.middleware.PaginationMiddleware', - 'django.middleware.csrf.CsrfViewMiddleware', - 'django.contrib.auth.middleware.AuthenticationMiddleware', - 'django.middleware.clickjacking.XFrameOptionsMiddleware', - - # If you use SessionAuthenticationMiddleware, be sure it appears before OAuth2TokenMiddleware. - # SessionAuthenticationMiddleware is NOT required for using django-oauth-toolkit. - 'django.contrib.auth.middleware.SessionAuthenticationMiddleware', - 'oauth2_provider.middleware.OAuth2TokenMiddleware', - ) - ... - -AUTHENTICATION_BACKENDS -^^^^^^^^^^^^^^^^^^^^^^^ - -In order to allow GeoNode to act as an OAuth2 Provider, we need to enable the ``oauth2_provider.backends.OAuth2Backend`` DJango backend provided by the "Django OAuth Toolkit". -Also notice that we need to specify the OAuth2 Provider scopes and declare which ``generator`` to use in order to create ``OAuth2 Client IDs``. - -Default values are: - -.. code-block:: python - - ... - # Replacement of default authentication backend in order to support - # permissions per object. - AUTHENTICATION_BACKENDS = ( - 'oauth2_provider.backends.OAuth2Backend', - 'django.contrib.auth.backends.ModelBackend', - 'guardian.backends.ObjectPermissionBackend', - ) - - OAUTH2_PROVIDER = { - 'SCOPES': { - 'read': 'Read scope', - 'write': 'Write scope', - 'groups': 'Access to your groups' - }, - - 'CLIENT_ID_GENERATOR_CLASS': 'oauth2_provider.generators.ClientIdGenerator', - } - ... - -Django OAuth Toolkit Admin Setup -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Once the ``settings.py`` and ``local_settings.py`` have been correctly configured for your system: - -#. Complete the GeoNode setup steps - - * Prepare the model - - .. code-block:: python - - python manage.py makemigrations - python manage.py migrate - python manage.py syncdb - - * Prepare the static data - - .. code-block:: python - - python manage.py collectstatic - - * Make sure the database has been populated with initial default data - - .. warning:: *Deprecated* this command will be replaced by migrations in the future, so be careful. - - .. code-block:: python - - python manage.py loaddata initial_data.json - - * Make sure there exists a superuser for your environment - - .. warning:: *Deprecated* this command will be replaced by migrations in the future, so be careful. - - .. code-block:: python - - python manage.py createsuperuser - - .. note:: Read the base tutorials on GeoNode Developer documentation for details on the specific commands and how to use them. - -#. Start the application - - Start GeoNode accordingly on how the setup has been done; run debug mode through ``paver``, or proxied by an HTTP Server like Apache2 HTTPD, Nginx or others. - -#. Finalize the setup of the OAuth2 Provider - - First of all you need to configure and create a new OAuth2 Application called ``GeoServer`` through the GeoNode Admin Dashboard - - * Access the GeoNode Admin Dashboard - - .. figure:: img/oauth002.png - - * Go to ``Django OAuth Toolkit`` > ``Applications`` - - .. figure:: img/oauth003.png - - * Update or create the Application named ``GeoServer`` - - .. warning:: The Application name **must** be ``GeoServer`` - - .. figure:: img/oauth004.png - - - ``Client id``; An alphanumeric code representing the OAuth2 Client Id. GeoServer OAuth2 Plugin **will** use **this** value. - - .. warning:: In a production environment it is **highly** recommended to modify the default value provided with GeoNode installation. - - - ``User``; Search for the ``admin`` user. Its ``ID`` will be automatically updated into the form. - - - ``Redirect uris``; It is possible to specify many URIs here. Those must coincide with the GeoServer instances URIs. - - - ``Client type``; Choose ``Confidential`` - - - ``Authorization grant type``; Choose ``Authorization code`` - - - ``Client secret``; An alphanumeric code representing the OAuth2 Client Secret. GeoServer OAuth2 Plugin **will** use **this** value. - - .. warning:: In a production environment it is **highly** recommended to modify the default value provided with GeoNode installation. - - - ``Name``; **Must** be ``GeoServer`` - -GeoServer Security Backend --------------------------- - -GeoServer Security Subsystem -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -GeoServer has a robust security subsystem, modeled on Spring Security. Most of the security features are available through the Web administration interface. - -For more details on how this works and how to configure and modify it, please refer to the official GeoServer guide http://docs.geoserver.org/stable/en/user/security/webadmin/index.html - -By using the ``GeoServer Data Dir`` provided with GeoNode build, the following configuration are already available. You will need just to update them accordingly to your environment (like IP addresses and Host names, OAuth2 Keys, and similar things). -However it is recommended to read carefully all the following passages in order to understand exactly how the different component are configured and easily identify any possible issue during the deployment. - -The main topics of this section are: - -#. Connection to the GeoNode REST Role Service - -#. Setup of the GeoServer OAuth2 Authentication Filter - -#. Configuration of the GeoServer Filter Chains - -#. Setup and test of the GeoFence Server and Default Rules - -Connection to the GeoNode REST Role Service -------------------------------------------- - -Preliminary checks -^^^^^^^^^^^^^^^^^^ - -* GeoServer is up and running and you have admin rights - -* GeoServer must reach the GeoNode instance via HTTP - -* The GeoServer Host IP Address must be allowed to access the GeoNode Role Service APIs (see the section ``AUTH_IP_WHITELIST`` above) - -Setup of the GeoNode REST Role Service -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -#. Login as ``admin`` to the GeoServer GUI - - .. warning:: In a production system remember to change the default admin credentials ``admin`` \ ``geoserver`` - - .. figure:: img/oauth005.png - -#. Access the ``Security`` > ``Users, Groups, Roles`` section - - .. figure:: img/oauth006.png - -#. **If not yet configured** the service ``geonode REST role service``, click on ``Role Services`` > ``Add new`` - - .. note:: This passage is **not** needed if the ``geonode REST role service`` has been already created. If so it will be displayed amond the Role Services list - - .. figure:: img/oauth008.png - - .. figure:: img/oauth007.png - -#. **If not yet configured** the service ``geonode REST role service``, choose ``AuthKEY REST - Role service from REST endpoint`` - - .. figure:: img/oauth009.png - -#. Create / update the ``geonode REST role service`` accordingly - - .. figure:: img/oauth010.png - - - ``Name``; **Must** be ``geonode REST role service`` - - - ``Base Server URL``; Must point to the GeoNode instance base URL (e.g. ``http://``) - - - ``Roles REST Endpoint``; Enter ``/api/roles`` - - - ``Admin Role REST Endpoint``; Enter ``/api/adminRole`` - - - ``Users REST Endpoint``; Enter ``/api/users`` - - - ``Roles JSON Path``; Enter ``$.groups`` - - - ``Admin Role JSON Path``; Enter ``$.adminRole`` - - - ``Users JSON Path``; Enter ``$.users[0].groups`` - - Once everything has been setup and it is working, choose the ``Administrator role`` and ``Group administrator role`` as ``ROLE_ADMIN`` - -Allow GeoFence to validate rules with ``ROLES`` -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. warning:: The following instruction are different accordingly to the GeoServer version you are currently using. - -GeoServer 2.9.x and 2.10.x --------------------------- - -#. Access the ``Security`` > ``Settings`` section - - .. figure:: img/oauth011.png - -#. Choose the ``geonode REST role service`` as ``Active role service`` - - .. figure:: img/oauth012.png - -GeoServer 2.12.x and above --------------------------- - -With the latest updates to GeoFence Plugin, the latter no more recognizes the Role Service from the default settings but from the ``geofence-server.properties`` file. - -That said, it is important that the ``Security`` > ``Settings`` role service will be set to **default**, in order to allow GeoServer following the standard authorization chain. - -On the other side, you will need to be sure that the ``geofence-server.properties`` file under the ``$GEOSERVER_DATA_DIR/geofence`` folder, contains the two following additional properties: :: - - gwc.context.suffix=gwc - org.geoserver.rest.DefaultUserGroupServiceName=geonode REST role service - - -Setup of the GeoServer OAuth2 Authentication Filter ---------------------------------------------------- - -It is necessary now check that GeoServer can connect to OAuth2 Providers (specifically to GeoNode OP), and being able to Authenticate users through it. - -Preliminary checks -^^^^^^^^^^^^^^^^^^ - -* GeoServer is up and running and you have admin rights - -* GeoServer must reach the GeoNode instance via HTTP - -* OAuth2 ``Client ID`` and ``Client Secret`` have been generated on GeoNode and known - -Setup of the GeoNode OAuth2 Security Filter -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -#. Access the ``Security`` > ``Authentication`` section - - .. figure:: img/oauth013.png - -#. **If not yet configured** the Authentication Filter ``geonode-oauth2 - Authentication using a GeoNode OAuth2``, click on ``Authentication Filters`` > ``Add new`` - - .. note:: This passage is **not** needed if the ``geonode-oauth2 - Authentication using a GeoNode OAuth2`` has been already created. If so it will be displayed amond the Authentication Filters list - - .. figure:: img/oauth015.png - - .. figure:: img/oauth014.png - -#. **If not yet configured** the Authentication Filter ``geonode-oauth2 - Authentication using a GeoNode OAuth2``, choose ``GeoNode OAuth2 - Authenticates by looking up for a valid GeoNode OAuth2 access_token key sent as URL parameter`` - - .. figure:: img/oauth016.png - -#. Create / update the ``geonode-oauth2 - Authentication using a GeoNode OAuth2`` accordingly - - .. figure:: img/oauth017.png - - - ``Name``; **Must** be ``geonode-oauth2`` - - - ``Enable Redirect Authentication EntryPoint``; It is recommended to put this to ``False``, otherwise GeoServer won't allow you to connect to its Admin GUI through the ``Form`` but only through GeoNode - - - ``Login Authentication EndPoint``; Unless you have specific needs, keep the default value ``/j_spring_oauth2_geonode_login`` - - - ``Logout Authentication EndPoint``; Unless you have specific needs, keep the default value ``/j_spring_oauth2_geonode_logout`` - - - ``Force Access Token URI HTTPS Secured Protocol``; This must be ``False`` unless you enabled a ``Secured Connection`` on GeoNode. In that case you will need to trust the GeoNode ``Certificate`` on the GeoServer JVM Kaystore. Please see details below - - - ``Access Token URI``; Set this to ``http:///o/token/`` - - - ``Force User Authorization URI HTTPS Secured Protocol``; This must be ``False`` unless you enabled a ``Secured Connection`` on GeoNode. In that case you will need to trust the GeoNode ``Certificate`` on the GeoServer JVM Kaystore. Please see details below - - - ``User Authorization URI``; Set this to ``http:///o/authorize/`` - - - ``Redirect URI``; Set this to ``http:///geoserver``. This address **must** be presenet on the ``Reditect uris`` of GeoNode ``OAuth2`` > ``Applications`` > ``GeoServer`` (see above) - - - ``Check Token Endpoint URL``; Set this to ``http:///api/o/v4/tokeninfo/`` - - - ``Logout URI``; Set this to ``http:///account/logout/`` - - - ``Scopes``; Unless you have specific needs, keep the default value ``read,write,groups`` - - - ``Client ID``; The ``Client id`` alphanumeric key generated by the GeoNode ``OAuth2`` > ``Applications`` > ``GeoServer`` (see above) - - - ``Client Secret``; The ``Client secret`` alphanumeric key generated by the GeoNode ``OAuth2`` > ``Applications`` > ``GeoServer`` (see above) - - - ``Role source``; In order to authorize the user against GeoNode, choose ``Role service`` > ``geonode REST role service`` - -Configuration of the GeoServer Filter Chains --------------------------------------------- - -The following steps ensure GeoServer can adopt more Authentication methods. As stated above, it is possible to Authenticate to GeoServer using different protocols. - -GeoServer scans the authentication filters chain associated to the specified path and tries them one by one sequentially. -The first one matching the protocol and able to grant access to the user, breaks the cycle by creating a ``User Principal`` and injecting it into the GeoServer ``SecurityContext``. -The Authentication process, then, ends here and the control goes to the Authorization one, which will try to retrieve the authenticated user's Roles through the available GeoServer Role Services associated to the Authentication Filter that granted the access. - -Preliminary checks -^^^^^^^^^^^^^^^^^^ - -* GeoServer is up and running and you have admin rights - -* GeoServer must reach the GeoNode instance via HTTP - -* The ``geonode-oauth2 - Authentication using a GeoNode OAuth2`` Authentication Filter and the ``geonode REST role service`` have been correctly configured - -Setup of the GeoServer Filter Chains -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -#. Access the ``Security`` > ``Authentication`` section - - .. figure:: img/oauth013.png - -#. Identify the section ``Filter Chains`` - - .. figure:: img/oauth018.png - -#. Make sure the ``web`` Filter Chain is configured as shown below - - .. figure:: img/oauth019.png - - .. warning:: Every time you modify a Filter Chain, **don't forget to save** the ``Authentication`` settings. This **must** be done for **each** change. - - .. figure:: img/oauth020.png - -#. Make sure the ``rest`` Filter Chain is configured as shown below - - .. figure:: img/oauth021.png - - .. warning:: Every time you modify a Filter Chain, **don't forget to save** the ``Authentication`` settings. This **must** be done for **each** change. - - .. figure:: img/oauth020.png - -#. Make sure the ``gwc`` Filter Chain is configured as shown below - - .. figure:: img/oauth022.png - - .. warning:: Every time you modify a Filter Chain, **don't forget to save** the ``Authentication`` settings. This **must** be done for **each** change. - - .. figure:: img/oauth020.png - -#. Make sure the ``default`` Filter Chain is configured as shown below - - .. figure:: img/oauth023.png - - .. warning:: Every time you modify a Filter Chain, **don't forget to save** the ``Authentication`` settings. This **must** be done for **each** change. - - .. figure:: img/oauth020.png - -#. Add the ``GeoNode Login Endpoints`` to the comma-delimited list of the ``webLogin`` Filter Chain - - .. figure:: img/oauth024.png - - .. warning:: Every time you modify a Filter Chain, **don't forget to save** the ``Authentication`` settings. This **must** be done for **each** change. - - .. figure:: img/oauth020.png - -#. Add the ``GeoNode Logout Endpoints`` to the comma-delimited list of the ``webLogout`` Filter Chain - - .. figure:: img/oauth025.png - - .. warning:: Every time you modify a Filter Chain, **don't forget to save** the ``Authentication`` settings. This **must** be done for **each** change. - - .. figure:: img/oauth020.png - - -#. Add the ``GeoNode Logout Endpoints`` to the comma-delimited list of the ``formLogoutChain`` XML node in ``/security/filter/formLogout/config.xml`` - - You will need a text editor to modify the file. - - .. note:: If the ```` XML node does not exist at all, create a **new one** as specified below - - .. code-block:: xml - - - ... - /web/ - /j_spring_security_logout,/j_spring_security_logout/,/j_spring_oauth2_geonode_logout,/j_spring_oauth2_geonode_logout/ - - - .. warning:: The value ``j_spring_oauth2_geonode_logout`` **must** be the same specified as ``Logout Authentication EndPoint`` in the ``geonode-oauth2 - Authentication using a GeoNode OAuth2`` above. - -Setup and test of the GeoFence Server and Default Rules -------------------------------------------------------- - -In order to work correctly, GeoServer needs the `GeoFence Embedded Server `_ plugin to be installed and configured on the system. - -The GeoServer configuration provided for GeoNode, has the plugin already installed with a default configuration. In that case double check that the plugin works correctly and the default rules have been setup by following the next steps. - -Preliminary checks -^^^^^^^^^^^^^^^^^^ - -* GeoServer is up and running and you have admin rights - -* The `GeoFence Embedded Server `_ plugin has been installed on GeoServer - -Setup of the GeoServer Filter Chains -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -#. Access the ``Security`` > ``Authentication`` section - - .. figure:: img/oauth013.png - -#. Identify the section ``Authentication Providers`` and make sure the ``geofence`` Authentication Provider is present - - .. figure:: img/oauth032.png - -#. Make sure the ``Provider Chain`` is configured as shown below - - .. figure:: img/oauth033.png - - .. warning:: Every time you modify a Authentication Providers, **don't forget to save** the ``Authentication`` settings. This **must** be done for **each** change. - - .. figure:: img/oauth020.png - -Setup of the GeoFence Server and Rules -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -#. Make sure GeoFence server works and the default settings are correctly configured - - - Access the ``Security`` > ``GeoFence`` section - - .. figure:: img/oauth026.png - - - Make sure the ``Options`` are configured as follows and the server works well when performing a ``Test Connection`` - - .. figure:: img/oauth027.png - - * ``Allow remote and inline layers in SLD``; Set it to ``True`` - - * ``Allow SLD and SLD_BODY parameters in requests``; Set it to ``True`` - - * ``Authenticated users can write``; Set it to ``True`` - - * ``Use GeoServer roles to get authorizations``; Set it to ``False`` - -#. Check the GeoFence default Rules - - - Access the ``Security`` > ``GeoFence Data Rules`` section - - .. figure:: img/oauth028.png - - - Make sure the ``DENY ALL`` Rule is present by default, otherwise your data will be accessible to everyone - - .. note:: This rule is **always** the last one - - .. figure:: img/oauth029.png - - .. warning:: If that rule does not exists **at the very bottom** (this rule is **always** the last one), add it manually. - - - Access the ``Security`` > ``GeoFence Admin Rules`` section - - .. figure:: img/oauth030.png - - - No Rules needed here - - .. figure:: img/oauth031.png - -Throubleshooting and Advanced Features --------------------------------------- - -Common Issues and Fixes -^^^^^^^^^^^^^^^^^^^^^^^ - -* GeoServer/GeoNode OAuth2 does not authenticate as Administrator even using GeoNode ``admin`` users - - **Symptoms** - - When trying to authenticate with an ``admin`` user using OAuth2, the process correctly redirects to GeoServer page but I'm not a GeoServer Administrator. - - **Cause** - - That means that somehow GeoServer could not successfully complete the Authorization and Authentication process. - - The possible causes of the problem may be the following ones: - - 1. The OAuth2 Authentication fails on GeoServer side - - This is usually due to an exception while trying to complete the Authentication process. - - - A typical cause is that GeoServer tries to use HTTPS connections but the GeoNode certificate is not trusted; - - In that case please refer to the section below. Also take a look at the logs (in particular the GeoServer one) as explained in :ref:`debug_geonode`. - The GeoServer logs should contain a detailed Exception explaining the cause of the problem. - If no exception is listed here (even after raised the log level to *DEBUG*), try to check for the GeoNode Role Service as explained below. - - - Another possible issue is that somehow the OAuth2 handshake cannot complete successfully; - - 1. Login into GeoServer as administrator through its WEB login form. - - 2. Double check that all the ``geonode-oauth2 - Authentication using a GeoNode OAuth2`` parameters are correct. If everything is ok, take a look at the logs (in particular the GeoServer one) as explained in :ref:`debug_geonode`. - The GeoServer logs should contain a detailed Exception explaining the cause of the problem. If no exception is listed here (even after raised the log level to *DEBUG*), try to check for the GeoNode Role Service as explained below. - - 2. GeoServer is not able to retrieve the user Role from a Role Service - - Always double check both HTTP Server and GeoServer log as specified in section :ref:`debug_geonode`. This might directly guide you to the cause of the problem. - - - Check that the GeoServer host is granted to access GeoNode Role Service REST APIs in the ``AUTH_IP_WHITELIST`` of the ``settings.py`` - - - Check that the ``geonode REST role service`` is the default Role service and that the GeoServer OAuth2 Plugin has been configured to use it by default - - - Check that the GeoNode REST Role Service APIs are functional and produce correct JSON. - - This is possible by using simple ``cUrl`` GET calls like - - .. code-block:: shell - - curl http://localhost/api/adminRole - $> {"adminRole": "admin"} - - - curl http://localhost/api/users - $> {"users": [{"username": "AnonymousUser", "groups": ["anonymous"]}, {"username": "afabiani", "groups": ["anonymous", "test"]}, {"username": "admin", "groups": ["anonymous", "test", "admin"]}]} - - curl http://localhost/api/roles - $> {"groups": ["anonymous", "test", "admin"]} - - curl http://localhost/api/users/admin - $> {"users": [{"username": "admin", "groups": ["anonymous", "test", "admin"]}]} - - -How to setup ``HTTPS`` secured endpoints -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -In a production system it is a good practice to encrypt the connection between GeoServer and GeoNode. That would be possible by enabling HTTPS Protocol on the GeoNode REST Role Service APIs and OAuth2 Endpoints. - -Most of the times you will rely on a self-signed HTTPS connection using a generated certificate. That makes the connection *untrasted* and you will need to tell to the GeoServer Java Virtual Machine to trust it. - -This can be done by following the steps below. - -For any issue take a look at the logs (in particular the GeoServer one) as explained in :ref:`debug_geonode`. The GeoServer logs should contain a detailed Exception explaining the cause of the problem. - -SSL Trusted Certificates ------------------------- - -When using a custom ``Keystore`` or trying to access a non-trusted or self-signed SSL-protected OAuth2 Provider from a non-SSH connection, you will need to add the certificates to the JVM ``Keystore``. - -In order to do this you can follow the next steps: - - In this example we are going to - - #. Retrieve SSL Certificate from GeoNode domain: - - "Access Token URI" = https:///o/token/ therefore we need to trust ``https://`` or (``:443``) - - .. note:: You will need to get and trust certificates from every different HTTPS URL used on OAuth2 Endpoints. - - #. Store SSL Certificates on local hard-disk - - #. Add SSL Certificates to the Java Keystore - - #. Enable the JVM to check for SSL Certificates from the Keystore - -1. Retrieve the SSL Certificate from GeoNode domain - - Use the ``openssl`` command in order to dump the certificate - - For ``https://`` - - .. code-block:: shell - - openssl s_client -connect :443 - - .. figure:: img/google_ssl_001.png - :align: center - -2. Store SSL Certificate on local hard-disk - - Copy-and-paste the section ``-BEGIN CERTIFICATE-``, ``-END CERTIFICATE-`` and save it into a ``.cert`` file - - .. note:: ``.cert`` file are plain text files containing the ASCII characters included on the ``-BEGIN CERTIFICATE-``, ``-END CERTIFICATE-`` sections - - ``geonode.cert`` (or whatever name you want with ``.cert`` extension) - - .. figure:: img/google_ssl_003.png - :align: center - -3. Add SSL Certificates to the Java Keystore - - You can use the Java command ``keytool`` like this - - ``geonode.cert`` (or whatever name you want with ``.cert`` extension) - - .. code-block:: shell - - keytool -import -noprompt -trustcacerts -alias geonode -file geonode.cert -keystore ${KEYSTOREFILE} -storepass ${KEYSTOREPASS} - - or, alternatively, you can use some graphic tool which helps you managing the SSL Certificates and Keystores, like `Portecle `_ - - .. code-block:: shell - - java -jar c:\apps\portecle-1.9\portecle.jar - - .. figure:: img/google_ssl_005.png - :align: center - - .. figure:: img/google_ssl_006.png - :align: center - - .. figure:: img/google_ssl_007.png - :align: center - - .. figure:: img/google_ssl_008.png - :align: center - - .. figure:: img/google_ssl_009.png - :align: center - - .. figure:: img/google_ssl_010.png - :align: center - - .. figure:: img/google_ssl_011.png - :align: center - - .. figure:: img/google_ssl_012.png - :align: center - - .. figure:: img/google_ssl_013.png - :align: center - -4. Enable the JVM to check for SSL Certificates from the Keystore - - In order to do this, you need to pass a ``JAVA_OPTION`` to your JVM: - - .. code-block:: shell - - -Djavax.net.ssl.trustStore=F:\tmp\keystore.key - -5. Restart your server - -.. note:: Here below you can find a bash script which simplifies the Keystore SSL Certificates importing. Use it at your conveninece. - - .. code-block:: shell - - HOST=myhost.example.com - PORT=443 - KEYSTOREFILE=dest_keystore - KEYSTOREPASS=changeme - - # get the SSL certificate - openssl s_client -connect ${HOST}:${PORT} ${HOST}.cert - - # create a keystore and import certificate - keytool -import -noprompt -trustcacerts \ - -alias ${HOST} -file ${HOST}.cert \ - -keystore ${KEYSTOREFILE} -storepass ${KEYSTOREPASS} - - # verify we've got it. - keytool -list -v -keystore ${KEYSTOREFILE} -storepass ${KEYSTOREPASS} -alias ${HOST} - -GeoFence Advanced Features --------------------------- - -GeoFence Rules Management and Tutorials -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -* `This tutorial `_ shows how to install and configure the Geofence Internal Server plug-in. It shows how to create rules in two ways: using the GUI and REST methods. - -* GeoFence Rules can be created / updated / deleted through a REST API, accessible only by a GeoServer Admin user. You can find more details on how the GeoFence REST API works `here `_. - -GeoFence Rules Storage Configuration -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -By default GeoFence is configured to use a filesystem based DB stored on the GeoServer Data Dir ```_. - -1. Add ``Java Libraries`` to ``GeoServer`` - - .. code-block:: shell - - wget --no-check-certificate https://build.geo-solutions.it/geonode/geoserver/latest/hibernate-spatial-postgis-1.1.3.1/hibernate-spatial-postgis-1.1.3.1.jar - wget --no-check-certificate https://build.geo-solutions.it/geonode/geoserver/latest/postgis-jdbc-1.3.3/postgis-jdbc-1.3.3.jar - - cp hibernate-spatial-postgis-1.1.3.1.jar /WEB-INF/lib - cp postgis-jdbc-1.3.3.jar /WEB-INF/lib - - restart geoserver - -2. Either create a DB with the updated schema here https://github.com/geoserver/geofence/blob/master/doc/setup/sql/002_create_schema_postgres.sql or enable the hbm2ddl auto creation through the configuration file (see step ``3``) - - .. note:: Notice that "update" also creates the tables if they do not exist. In production, however, I would suggest to change it to "validate" - - .. code-block:: shell - - # If you want to create a new DB for GeoFence - sudo -u postgres createdb -O geonode geofence; \ - sudo -u postgres psql -d geofence -c 'CREATE EXTENSION postgis;'; \ - sudo -u postgres psql -d geofence -c 'GRANT ALL ON geometry_columns TO PUBLIC;'; \ - sudo -u postgres psql -d geofence -c 'GRANT ALL ON spatial_ref_sys TO PUBLIC;'; \ - sudo -u postgres psql -d geofence -c 'GRANT ALL PRIVILEGES ON ALL TABLES IN SCHEMA public TO geonode;' - -3. Add configuration similar to ``geofence-datasource-ovr.properties`` sample below (if loaded as GeoServer extension) - - **/geofence/geofence-datasource-ovr.properties** - - .. code-block:: shell - - # /* (c) 2019 Open Source Geospatial Foundation - all rights reserved - # * This code is licensed under the GPL 2.0 license, available at the root - # * application directory. - # */ - # - geofenceVendorAdapter.databasePlatform=org.hibernatespatial.postgis.PostgisDialect - geofenceDataSource.driverClassName=org.postgresql.Driver - geofenceDataSource.url=jdbc:postgresql://localhost:5432/geofence - geofenceDataSource.username=postgres - geofenceDataSource.password=postgres - geofenceEntityManagerFactory.jpaPropertyMap[hibernate.default_schema]=public - - ################################################################################ - ## Other setup entries - ################################################################################ - ## hbm2ddl.auto may assume one of these values: - ## - validate: validates the DB schema at startup against the internal model. May fail on oracle spatial. - ## - update: updates the schema, according to the internal model. Updating automatically the production DB is dangerous. - ## - create-drop: drop the existing schema and recreates it according to the internal model. REALLY DANGEROUS, YOU WILL LOSE YOUR DATA. - ## You may want not to redefine the property entirely, in order to leave the defult value (no action). - - geofenceEntityManagerFactory.jpaPropertyMap[hibernate.hbm2ddl.auto]=update - geofenceEntityManagerFactory.jpaPropertyMap[javax.persistence.validation.mode]=none - geofenceEntityManagerFactory.jpaPropertyMap[hibernate.validator.apply_to_ddl]=false - geofenceEntityManagerFactory.jpaPropertyMap[hibernate.validator.autoregister_listeners]=false - - ## - ## ShowSQL is set to true in the configuration file; putting showsql=false in - ## this file, you can easily check that this override file has been properly applied. - - # geofenceVendorAdapter.generateDdl=false - # geofenceVendorAdapter.showSql=false - - ## Set to "true" in specific use cases - # workspaceConfigOpts.showDefaultGroups=false - - - - ################################################################################ - ## Disable second level cache. - ## This is needed in a geofence-clustered environment. - - #geofenceEntityManagerFactory.jpaPropertyMap[hibernate.cache.use_second_level_cache]=false - - ################################################################################ - ## Use external ehcache configuration file. - ## Useful to change cache settings, for example diskStore path. - #geofenceEntityManagerFactory.jpaPropertyMap[hibernate.cache.provider_configuration_file_resource_path]=file:/path/to/geofence-ehcache-override.xml diff --git a/docs/advanced/contrib/img/add_centralized_server.png b/docs/advanced/contrib/img/add_centralized_server.png deleted file mode 100644 index 85e19ffe594..00000000000 Binary files a/docs/advanced/contrib/img/add_centralized_server.png and /dev/null differ diff --git a/docs/advanced/contrib/img/centralized_server_admin_ui.png b/docs/advanced/contrib/img/centralized_server_admin_ui.png deleted file mode 100644 index ba5329c5df2..00000000000 Binary files a/docs/advanced/contrib/img/centralized_server_admin_ui.png and /dev/null differ diff --git a/docs/advanced/contrib/img/dispatch_metrics_task.png b/docs/advanced/contrib/img/dispatch_metrics_task.png deleted file mode 100644 index 10cd9996051..00000000000 Binary files a/docs/advanced/contrib/img/dispatch_metrics_task.png and /dev/null differ diff --git a/docs/advanced/contrib/img/dispatch_metrics_task_details.png b/docs/advanced/contrib/img/dispatch_metrics_task_details.png deleted file mode 100644 index 3a4220e1b9d..00000000000 Binary files a/docs/advanced/contrib/img/dispatch_metrics_task_details.png and /dev/null differ diff --git a/docs/advanced/contrib/img/periodic_tasks_section.png b/docs/advanced/contrib/img/periodic_tasks_section.png deleted file mode 100644 index 83605abec9f..00000000000 Binary files a/docs/advanced/contrib/img/periodic_tasks_section.png and /dev/null differ diff --git a/docs/advanced/contrib/index.rst b/docs/advanced/contrib/index.rst deleted file mode 100644 index 4dc87b6f7a4..00000000000 --- a/docs/advanced/contrib/index.rst +++ /dev/null @@ -1,596 +0,0 @@ -Geonode auth via LDAP -===================== - -This package provides utilities for using LDAP as an authentication and -authorization backend for geonode. - -The `django_auth_ldap `_ package is a very capable way to add LDAP integration -with django projects. It provides a lot of flexibility in mapping LDAP users to -geonode users and is able to manage user authentication. - -However, in order to provide full support for mapping LDAP groups with -geonode's and enforce group permissions on resources, a custom geonode -authentication backend is required. This contrib package provides such a -backend, based on `django_auth_ldap `_. - - -Installation ------------- - -Installing this contrib package is a matter of: - -1. Installing geonode -2. Installing system LDAP libraries (development packages needed) -3. Cloning this repository locally -4. Change to the `ldap` directory and install this contrib package - -.. code-block:: sh - - # 1. install geonode (not shwn here for brevity) - # 2. install systemwide LDAP libraries - sudo apt install \ - libldap2-dev \ - libsasl2-dev - - # 3. get geonode/contribs code - git clone https://github.com/GeoNode/geonode-contribs.git - - # 4. install geonode ldap contrib package - cd geonode-contribs/ldap - pip install . - -Configuration -------------- - -1. Add ``geonode_ldap.backend.GeonodeLdapBackend`` as an additional auth - backend. - - .. code-block:: python - - # e.g. by updating your settings.py or local_settings.py - AUTHENTICATION_BACKENDS += ( - "geonode_ldap.backend.GeonodeLdapBackend", - ) - - You may use additional auth backends, the django authentication framework - tries them all according to the order listed in the settings. This means that - geonode can be setup in such a way as to permit internal organization users - to login with their LDAP credentials, while at the same time allowing for - casual users to use their facebook login (as long as you enable facebook - social auth provider). - - .. note:: The django's ``django.contrib.auth.backends.ModelBackend`` must also be used in order to provide full geonode integration with LDAP. - However this is included by default on GeoNode ``settings`` - - .. code-block:: python - - # The GeoNode default settings are the following - AUTHENTICATION_BACKENDS = ( - 'oauth2_provider.backends.OAuth2Backend', - 'django.contrib.auth.backends.ModelBackend', - 'guardian.backends.ObjectPermissionBackend', - 'allauth.account.auth_backends.AuthenticationBackend', - ) - -2. Set some additional configuration values. Some of these variables are - prefixed with ``AUTH_LDAP`` (these are used directly by `django_auth_ldap `_) - while others are prefixed with ``GEONODE_LDAP`` (these are used by - ``geonode_ldap``). The geonode custom variables are: - - * ``GEONODE_LDAP_GROUP_PROFILE_FILTERSTR`` - This is an LDAP search fragment - with the filter that allows querying for existing groups. See example below - - * ``GEONODE_LDAP_GROUP_NAME_ATTRIBUTE`` - This is the name of the LDAP - attribute that will be used for deriving the geonode group name. If not - specified it will default to `cn`, which means that the LDAP object's - `common name` will be used for generating the name of the geonode group - - * ``GEONODE_LDAP_GROUP_PROFILE_MEMBER_ATTR`` - This is the name of the LDAP - attribute that will be used for deriving the geonode membership. If not - specified it will default to ``member`` - - -Example configuration: - -.. code-block:: python - - # add these import lines to the top of your geonode settings file - from django_auth_ldap import config as ldap_config - from geonode_ldap.config import GeonodeNestedGroupOfNamesType - import ldap - - # add both standard ModelBackend auth and geonode.contrib.ldap auth - AUTHENTICATION_BACKENDS += ( - 'geonode_ldap.backend.GeonodeLdapBackend', - ) - - # django_auth_ldap configuration - AUTH_LDAP_SERVER_URI = env("LDAP_SERVER_URL") - AUTH_LDAP_BIND_DN = env("LDAP_BIND_DN") - AUTH_LDAP_BIND_PASSWORD = env("LDAP_BIND_PASSWORD") - AUTH_LDAP_USER_SEARCH = ldap_config.LDAPSearch( - env("LDAP_USER_SEARCH_DN"), - ldap.SCOPE_SUBTREE, - env("LDAP_USER_SEARCH_FILTERSTR") - ) - AUTH_LDAP_GROUP_SEARCH = ldap_config.LDAPSearch( - env("LDAP_GROUP_SEARCH_DN"), - ldap.SCOPE_SUBTREE, - env("LDAP_GROUP_SEARCH_FILTERSTR") - ) - AUTH_LDAP_GROUP_TYPE = GeonodeNestedGroupOfNamesType() - AUTH_LDAP_USER_ATTR_MAP = { - "first_name": "givenName", - "last_name": "sn", - "email": "mailPrimaryAddress" - } - AUTH_LDAP_FIND_GROUP_PERMS = True - AUTH_LDAP_MIRROR_GROUPS_EXCEPT = [ - "test_group" - ] - - # these are not needed by django_auth_ldap - we use them to find and match - # GroupProfiles and GroupCategories - GEONODE_LDAP_GROUP_NAME_ATTRIBUTE = env("LDAP_GROUP_NAME_ATTRIBUTE", default="cn") - GEONODE_LDAP_GROUP_PROFILE_FILTERSTR = env("LDAP_GROUP_SEARCH_FILTERSTR", default='(ou=research group)') - GEONODE_LDAP_GROUP_PROFILE_MEMBER_ATTR = env("LDAP_GROUP_PROFILE_MEMBER_ATTR", default='member') - -Example environment variables: - -.. code-block:: shell - - LDAP_SERVER_URL=ldap:// - LDAP_BIND_DN=uid=ldapinfo,cn=users,dc=ad,dc=example,dc=org - LDAP_BIND_PASSWORD= - LDAP_USER_SEARCH_DN=dc=ad,dc=example,dc=org - LDAP_USER_SEARCH_FILTERSTR=(&(uid=%(user)s)(objectClass=person)) - LDAP_GROUP_SEARCH_DN=cn=groups,dc=ad,dc=example,dc=org - LDAP_GROUP_SEARCH_FILTERSTR=(|(cn=abt1)(cn=abt2)(cn=abt3)(cn=abt4)(cn=abt5)(cn=abt6)) - LDAP_GROUP_PROFILE_MEMBER_ATTR=uniqueMember - -The configuration seen in the example above will allow LDAP users to login to -geonode with their LDAP credentials. - -On first login, a geonode user is created from the LDAP user and its LDAP -attributes ``cn`` and ``sn`` are used to populate the geonode user's -``first_name`` and ``last_name`` profile fields. - -Any groups that the user is a member of in LDAP (under the -``cn=groups,dc=ad,dc=example,dc=org`` search base and belonging to one of -``(|(cn=abt1)(cn=abt2)(cn=abt3)(cn=abt4)(cn=abt5)(cn=abt6))`` groups) will be mapped to the corresponding -geonode groups, even creating these groups in geonode in case they do not -exist yet. The geonode user is also made a member of these geonode groups. - -Upon each login, the user's geonode group memberships are re-evaluated -according to the information extracted from LDAP. The -``AUTH_LDAP_MIRROR_GROUPS_EXCEPT`` setting can be used to specify groups -whose memberships will not be re-evaluated. - -.. note:: Users mapped from LDAP will be marked with an ``ldap`` tag. This will be used to keep them in sync. - -.. warning:: If you remove the ``ldap`` tag, the users will be threated as pure internal GeoNode ones. - -You may also manually generate the geonode groups in advance, before users -login. In this case, when a user logs in and the mapped LDAP group already -exists, the user is merely added to the geonode group - -Be sure to check out `django_auth_ldap `_ for more information on the various -configuration options. - -Keep Users and Groups Synchronized ----------------------------------- - -In order to constantly keep the remote LDAP Users and Groups **synchronized** with GeoNode, -you will need to run periodically some specific management commands. - -.. code-block:: shell - - */10 * * * * /opt/geonode/my-geonode/manage.sh updateldapgroups >> /var/log/cron.log 2>&1 - */10 * * * * /opt/geonode/my-geonode/manage.sh updateldapusers >> /var/log/cron.log 2>&1 - -Where the ``manage.sh`` is a bash script similar to the following one: - -**manage.sh** - -.. code-block:: shell - - export $(grep -v '^#' /opt/geonode/my-geonode/.env | xargs -d '\n'); /home//.virtualenvs/geonode/bin/python /opt/geonode/my-geonode/manage.py $@ - -and the ``/opt/geonode/my-geonode/.env`` is something similar to the following one: - -**/opt/geonode/my-geonode/.env** - -.. code-block:: shell - - DEBUG=False - DJANGO_ALLOWED_HOSTS=,localhost,127.0.0.1 - DJANGO_DATABASE_URL=postgresql://my_geonode:**********@localhost:5432/my_geonode_db - DEFAULT_BACKEND_UPLOADER=geonode.importer - DEFAULT_FROM_EMAIL=geonode@example.org - DJANGO_EMAIL_HOST=smtp.example.org - DJANGO_EMAIL_HOST_PASSWORD=********** - DJANGO_EMAIL_HOST_USER=geonode - DJANGO_EMAIL_PORT=465 - DJANGO_EMAIL_USE_SSL=True - DJANGO_SETTINGS_MODULE=my_geonode.settings - DJANGO_SECRET_KEY=********** - OAUTH2_API_KEY=********** - PROXY_URL=/proxy/?url= - EXIF_ENABLED=True - EMAIL_ENABLE=True - TIME_ENABLED=True - ACCOUNT_OPEN_SIGNUP=True - ACCOUNT_APPROVAL_REQUIRED=True - ACCOUNT_EMAIL_REQUIRED=True - ACCOUNT_EMAIL_VERIFICATION=optional - AVATAR_GRAVATAR_SSL=True - GEONODE_DB_URL=postgis://my_geonode:**********@localhost:5432/my_geonode_data - GEOSERVER_ADMIN_PASSWORD=********** - GEOSERVER_LOCATION=https:///geoserver/ - GEOSERVER_PUBLIC_HOST= - GEOSERVER_PUBLIC_LOCATION=https:///geoserver/ - GEOSERVER_WEB_UI_LOCATION=https:///geoserver/ - LDAP_SERVER_URL=ldap:// - LDAP_BIND_DN=uid=ldapinfo,cn=users,dc=ad,dc=example,dc=org - LDAP_BIND_PASSWORD= - LDAP_USER_SEARCH_DN=dc=ad,dc=example,dc=org - LDAP_USER_SEARCH_FILTERSTR=(&(uid=%(user)s)(objectClass=person)) - LDAP_GROUP_SEARCH_DN=cn=groups,dc=ad,dc=example,dc=org - LDAP_GROUP_SEARCH_FILTERSTR=(|(cn=abt1)(cn=abt2)(cn=abt3)(cn=abt4)(cn=abt5)(cn=abt6)) - LDAP_GROUP_PROFILE_MEMBER_ATTR=uniqueMember - OGC_REQUEST_MAX_RETRIES=3 - OGC_REQUEST_POOL_CONNECTIONS=100 - OGC_REQUEST_POOL_MAXSIZE=100 - OGC_REQUEST_TIMEOUT=60 - SITEURL=https:/// - SITE_HOST_NAME= - FREETEXT_KEYWORDS_READONLY=False - # Advanced Workflow Settings - ADMIN_MODERATE_UPLOADS=False - GROUP_MANDATORY_RESOURCES=False - GROUP_PRIVATE_RESOURCES=False - RESOURCE_PUBLISHING=False - -.. note:: You might want to use the same ``/opt/geonode/my-geonode/.env`` for your ``UWSGI`` configuration too: - - .. code-block:: shell - - [uwsgi] - socket = 0.0.0.0:8000 - uid = - gid = www-data - - plugins = python - virtualenv = /home//.virtualenvs/geonode - - # set environment variables from .env file - env LANG=en_US.utf8 - env LC_ALL=en_US.UTF-8 - env LC_LANG=en_US.UTF-8 - - for-readline = /opt/geonode/my-geonode/.env - env = %(_) - endfor = - - chdir = /opt/geonode/my-geonode - module = my_geonode.wsgi:application - - processes = 12 - threads = 2 - enable-threads = true - master = true - - # logging - # path to where uwsgi logs will be saved - logto = /storage/my_geonode/logs/geonode.log - daemonize = /storage/my_geonode/logs/geonode.log - touch-reload = /opt/geonode/my-geonode/my_geonode/wsgi.py - buffer-size = 32768 - max-requests = 500 - harakiri = 300 # respawn processes taking more than 5 minutes (300 seconds) - # limit-as = 1024 # avoid Errno 12 cannot allocate memory - harakiri-verbose = true - vacuum = true - thunder-lock = true - -.. _centralized-monitoring: - -Geonode Logstash for centralized monitoring/analytics -===================================================== - -This contrib app, along with the GeoNode internal monitoring app, lets administrators -to configure a service for sending metrics data to a **centralized server** -which comes with `Logstash `_. - -So it will be possible to visualize stats and charts about one or more GeoNode instances outside the application. -Having a server configured with the `ELK stack `_, -it is possible to visualize those information on a Kibana dashboard for example. - -If you manage more than one GeoNode instances, that server can receive data from -many GeoNode(s) so it can make available both *single-instance dashboards* -(referred to individual instances) and *global dashboards* -(stats calculated on the whole set of instances). - -.. warning:: The centralized monitoring service cannot be active if the settings variables :ref:`user-analytics` and :ref:`monitoring-enabled` are set to `False`. - -Overview --------- - -By default, GeoNode will send data to the centralized server every **3600 seconds** -(1 hour) so, if enabled, the monitoring app will collect 1-hour-aggregated data. -This time interval can be configured, see the next paragraphs to know how. - -Formatted and compressed data will be sent on a **TCP** connection (on the `443` standard port by default) -through a **scheduled celery task** which basically logs information -via `python-logstash-async `_. - -.. warning:: This feature requires `python-logstash-async `_. - -.. _events-formats: - -Data and events formats -~~~~~~~~~~~~~~~~~~~~~~~ - -Each time the centralized monitoring service is called, 4 types of *JSON* formatted events are sent to the server: - -1. Instance overview - - .. code-block:: json - - { - "format_version": "1.0", - "instance": { - "name": geonode instance HOSTNAME, - "ip": geonode instance IP - }, - "time": { - "startTime": UTC now - 1 hour (default) - "endTime": UTC now - }, - "hits": total number of requests, - "unique_visits": total number of unique sessions, - "unique_visitors": total number of unique users, - "registered_users": total number of registered users at the end time, - "layers": total number of layers at the end time, - "documents": total number of documents at the end time, - "maps": total number of maps at the end time, - "errors": total number of errors - } - -2. Resources details - - .. code-block:: json - - { - "format_version": "1.0", - "instance": { - "name": geonode instance HOSTNAME, - "ip": geonode instance IP - }, - "time": { - "startTime": UTC now - 1 hour (default) - "endTime": UTC now - }, - "resources": [ - … - { - "type": resource type, - "name": resource name, - "url": resource URL, - "hits": total number of requests about this resource, - "unique_visits": total number of unique sessions about this resource, - "unique_visitors": total number of unique users about this resource, - "downloads": total number of resource downloads, - "ogcHits": total number of OGC service requests about this resource, - "publications": total number of publication events - }, - … - ] - } - -3. Countries details - - .. code-block:: json - - { - "format_version": "1.0", - "instance": { - "name": geonode instance HOSTNAME, - "ip": geonode instance IP - }, - "time": { - "startTime": UTC now - 1 hour (default) - "endTime": UTC now - }, - "countries": [ - … - { - "name": country name, - "hits": total number of requests about the country - }, - … - ] - } - -4. UA (User Agent) Familie details - - .. code-block:: json - - { - "format_version": "1.0", - "instance": { - "name": geonode instance HOSTNAME, - "ip": geonode instance IP - }, - "time": { - "startTime": UTC now - 1 day - "endTime": UTC now - }, - "ua_families": [ - … - { - "name": UA family name - "hits": total number of requests about the UA family - }, - … - ] - } - -These messages will be `gzip `_ -compressed in order to improve transport performances and they should be parsed -by a `logstash filter `_ -on the server side (see :ref:`logstash-input`). - -Configuration -------------- - -The centralized monitoring service is disabled by default because it needs -the internal monitoring to be active and service-specific configurations. - -GeoNode configuration -~~~~~~~~~~~~~~~~~~~~~ - -| On the GeoNode side, all needed configurations can be set up from the Django admin interface. -| If enabled, the **GEONODE LOGSTASH** section will show the **Centralized servers** feature: - -.. image:: img/centralized_server_admin_ui.png - :alt: Centralized Servers from admin UI - -Let's add one: - -.. image:: img/add_centralized_server.png - :alt: Centralized Server set up - -The **Host** IP address and the **Port** number are mandatory as well as the -time **Interval** (3600 seconds by default) which defines the service -invocation polling (so the time range on which data should be aggregated). - -.. note:: Once the service configured, the user can test the configuration by clicking on **Test connection**. - It will test the connection with the centralized server without saving the configuration. - -Other settings come with a default value: - -* **Db path** --> the local SQLite database to cache events between emitting and transmission to the Logstash server (log events are cached even across process restarts and crashes); -* **Socket timeout** --> timeout in seconds for TCP connections; -* **Queue check interval** --> interval in seconds to check the internal queue for new messages to be cached in the database; -* **Queue events flush interval** --> interval in seconds to send cached events from the database to Logstash; -* **Queue events flush count** --> count of cached events to send from the database to Logstash; -* **Queue events batch size** --> maximum number of events to be sent to Logstash in one batch; -* **Logstash db timeout** --> timeout in seconds to 'connect' the SQLite database. - -To better understand what these variables mean, it is recommended to read the `python-logstash-async options for the asynchronous processing and formatting `_. - -Other three read-only fields will be visible: - -* **Last successful deliver** --> timestamp of the last successful deliver (if exists); -* **Next scheduled deliver** --> timestamp of the next scheduled deliver; -* **Last failed deliver** --> timestamp of the last failed deliver (if exists). - -.. _logstash-input: - -Logstash configuration -~~~~~~~~~~~~~~~~~~~~~~ - -| On the server side, a proper Logstash configuration should be set up. -| Some events formats contain arrays (see :ref:`events-formats`) so Logstash should - be able to retrieve a single event for each element of the array. - The `Split filter plugin `_ - helps to correctly parse those messages. -| As mentioned above, events messages will be gzip compressed so the - `Gzip_lines codec plugin `_ - should be installed along with Logstash and the "gzip_lines" codec should be used for the `tcp` input. - -An example of the logstash configuration: - -.. code-block:: json - - input { - tcp { - port => - codec => "gzip_lines" - } - } - - filter { - json { - source => "message" - } - if [format_version] == "1.0" { - if [countries] { - split { - field => "countries" - } - } - if [resources] { - split { - field => "resources" - } - } - if [ua_families] { - split { - field => "ua_families" - } - } - mutate { - remove_field => "message" - } - } - geoip { - source => "[instance][ip]" - } - } - - output { - elasticsearch { - hosts => "elasticsearch:" - index => "logstash-%{[instance][name]}-%{+YYYY.MM.dd}" - user => "elastic" - password => "changeme" - } - stdout { codec => rubydebug } - } - -Usage ------ - -When saving the service configuration, if monitoring enabled, GeoNode will create/update a celery -`Periodic Task `_ -which will be executed at regular intervals based on the *interval* configured. - -You can check this behaviour on the *Periodic Tasks* section of the admin UI: - -.. image:: img/periodic_tasks_section.png - :alt: Periodic tasks section - -The *dispatch-metrics-task* task: - -.. image:: img/dispatch_metrics_task.png - :alt: Dispatch metrics task - -The task details: - -.. image:: img/dispatch_metrics_task_details.png - :alt: Dispatch metrics task details - -.. warning:: When disabling monitoring is a **good practice** to disable the corresponding Periodic Task too. - -Management command -~~~~~~~~~~~~~~~~~~ - -| In addition to the scheduled task, this contrib app makes also available the - **dispatch_metrics** command to manually send metrics to the server. -| Obviously the time interval considered will start at the last successful - delivery and will finish at the current time. - -When the monitoring plugin is enabled (:ref:`user-analytics` and :ref:`monitoring-enabled` are set to `True`) -and a :ref:`centralized-monitoring` configured, Geonode sends (hourly by default) metrics data -to an external server (which comes with Logstash) for stats visualization and analysis. - -The command can be launched using the ``manage.py`` script. -No options are required. - -.. code-block:: shell - - $ DJANGO_SETTINGS_MODULE= python manage.py dispatch_metrics - -Possible exceptions raised during the execution will be reported to GeoNode log. diff --git a/docs/advanced/hardening/index.rst b/docs/advanced/hardening/index.rst deleted file mode 100644 index 723e6676c8a..00000000000 --- a/docs/advanced/hardening/index.rst +++ /dev/null @@ -1,27 +0,0 @@ -.. _geonode_on_https: - -Publish on HTTPS -================ - -TBD - -.. _oauth2_fixtures_and_migration: - -OAuth2 Fixtures Update and Base URL Migration -============================================= - -TBD - -.. _geonode_security_subsystem: - -GeoNode Security Subsystem -========================== - -TBD - -.. _oauth2_tokens_and_sessions: - -OAuth2 Tokens and Sessions -========================== - -TBD (ref to :ref:`oauth2_admin_panel_access_tokens`) \ No newline at end of file diff --git a/docs/advanced/index.rst b/docs/advanced/index.rst deleted file mode 100644 index 5765a86ddc5..00000000000 --- a/docs/advanced/index.rst +++ /dev/null @@ -1,35 +0,0 @@ -GeoNode Components and Architecture -=================================== - -.. toctree:: - :caption: GeoNode Components and Architecture - :maxdepth: 3 - - components/index - -Hardening GeoNode -================= - -.. toctree:: - :caption: Hardening GeoNode - :maxdepth: 3 - - hardening/index - -Social Login -============ - -.. toctree:: - :caption: Social Login - :maxdepth: 3 - - social/index - -GeoNode Django Contrib Apps -=========================== - -.. toctree:: - :caption: GeoNode Django Contrib Apps - :maxdepth: 3 - - contrib/index diff --git a/docs/advanced/social/index.rst b/docs/advanced/social/index.rst deleted file mode 100644 index 2c0d388b162..00000000000 --- a/docs/advanced/social/index.rst +++ /dev/null @@ -1,11 +0,0 @@ -Overview -======== - -Configuration -============= - -Linkedin -======== - -Facebook -======== diff --git a/docs/basic/index.rst b/docs/basic/index.rst deleted file mode 100644 index ff9d950a444..00000000000 --- a/docs/basic/index.rst +++ /dev/null @@ -1,26 +0,0 @@ -GeoNode Settings -================ - - :ref:`settings` - -.. toctree:: - :hidden: - :maxdepth: 3 - - settings/index - -Customise the Look and Feel -=========================== - -.. toctree:: - :maxdepth: 3 - - theme/index - -GeoNode permissions -=================== - -.. toctree:: - :maxdepth: 3 - - permissions/index diff --git a/docs/basic/permissions/img/add_to_shopping_cart.png b/docs/basic/permissions/img/add_to_shopping_cart.png deleted file mode 100644 index 9226abe37d1..00000000000 Binary files a/docs/basic/permissions/img/add_to_shopping_cart.png and /dev/null differ diff --git a/docs/basic/permissions/img/change_layer_permissions.png b/docs/basic/permissions/img/change_layer_permissions.png deleted file mode 100644 index 8bb0f0b7bb0..00000000000 Binary files a/docs/basic/permissions/img/change_layer_permissions.png and /dev/null differ diff --git a/docs/basic/permissions/img/resource_permissions_dialogue.png b/docs/basic/permissions/img/resource_permissions_dialogue.png deleted file mode 100644 index b4d0e29f3c3..00000000000 Binary files a/docs/basic/permissions/img/resource_permissions_dialogue.png and /dev/null differ diff --git a/docs/basic/permissions/img/shopping_cart_permissions.png b/docs/basic/permissions/img/shopping_cart_permissions.png deleted file mode 100644 index 60025bead2a..00000000000 Binary files a/docs/basic/permissions/img/shopping_cart_permissions.png and /dev/null differ diff --git a/docs/basic/permissions/index.rst b/docs/basic/permissions/index.rst deleted file mode 100644 index a2dc76940cb..00000000000 --- a/docs/basic/permissions/index.rst +++ /dev/null @@ -1,64 +0,0 @@ -.. _permissions: - -=========== -Permissions -=========== - -| Permissions in GeoNode are set per resource, where a resource can be a layer, a map, a document or a service. The way the permissions are set is the same for all of them. - -.. warning:: - - GeoNode has a set of default permissions that are applied on resource creation **when** you don't explicitly declare them. - This is particularly relevant when creating and saving a map, where you won't have the possibility to set the its permissions during the creation phase. - GeoNode can be tuned to make sure that by default the new created resource are not public, this can be done by changing two settings, see `Default view permissions <../settings/index.html#default-anonymous-view-permission>`_ and `Default download permissions <../settings/index.html#default-anonymous-download-permission>`_ - -Single Resource permissions ---------------------------- - -| Resource permissions can be generally set from the *resource detail* page. The following figure shows how to open the dialog to set permissions on a layer, the same concept applies to documents and maps. - -.. figure:: img/change_layer_permissions.png - :align: center - :width: 500 - - *Change Layer Permissions* - -| The dialog for setting the permission allow a granular selection of each permission type to be applied for users and/or groups, each permission type is grouped in tabs that are expanded on click. -| The text boxes have an autosuggest feature to help the compilation of user names and groups, it starts upon typing. - -.. figure:: img/resource_permissions_dialogue.png - :align: center - :width: 500 - - *Resource Permission Dialogue* - -You can set the following types of permissions: - -* *View* allows to view the layer; -* *Download* allows to download the layer; -* *Change Metadata* allows to change the layer metadata; -* *Edit Data* allows to change attributes and properties of the layers features; -* *Edit Style* allows to change the layer style; -* *Manage* allows to update, delete, change permissions, publish and unpublish the layer. - -.. warning:: When assigning permissions to a group, all the group members will have those permissions. Be careful in case of editing permissions. - -Bulk permissions ----------------- - -| GeoNode offers the possibility to set permissions in bulk, this can be done in any *list* page. -| In order to set bulk permissions you have first to fill the *shopping cart* with the resources you are interested with by clicking the :guilabel:`+` button on the resource snippet. - -.. figure:: img/add_to_shopping_cart.png - :align: center - :width: 500 - - *Add Resource To Shopping Cart* - -| Once happy with the selection you can click the :guilabel:`Set Permissions` button under the shopping cart to open the permissions dialogue that will apply the chosen permission to all selected resources. - -.. figure:: img/shopping_cart_permissions.png - :align: center - :width: 500 - - *Sopping Cart Permissions* diff --git a/docs/basic/settings/index.rst b/docs/basic/settings/index.rst deleted file mode 100644 index 6aeaee15863..00000000000 --- a/docs/basic/settings/index.rst +++ /dev/null @@ -1,2125 +0,0 @@ -.. _settings: - -======== -Settings -======== - -Here’s a list of settings available in GeoNode and their default values. This includes settings for some external applications that -GeoNode depends on. - -For most of them, default values are good. Those should be changed only for advanced configurations in production or heavily hardened systems. - -The most common ones can be set through ``environment`` variables to avoid touching the ``settings.py`` file at all. -This is a good practice and also the preferred one to configure GeoNode (and Django apps in general). -Whenever you need to change them, set the environment variable accordingly (where it is available) instead of overriding it through the ``local_settings``. - -.. comment: - :local: - :depth: 1 - -A -= - -ACCESS_TOKEN_EXPIRE_SECONDS ---------------------------- - - | Default: ``86400`` - | Env: ``ACCESS_TOKEN_EXPIRE_SECONDS`` - - When a user logs into GeoNode, if no ``ACCESS_TOKEN`` exists, a new one will be created with a default expiration time of ``ACCESS_TOKEN_EXPIRE_SECONDS`` seconds (1 day by default). - -ACCOUNT_ADAPTER ---------------- - - | Default: ``geonode.people.adapters.LocalAccountAdapter`` - - Custom GeoNode People (Users) Account Adapter. - -ACCOUNT_APPROVAL_REQUIRED -------------------------- - - | Default: ``False`` - | Env: ``ACCOUNT_APPROVAL_REQUIRED`` - - If ``ACCOUNT_APPROVAL_REQUIRED`` equals ``True``, newly registered users must be activated by a superuser through the Admin gui, before they can access GeoNode. - -ACCOUNT_CONFIRM_EMAIL_ON_GET ----------------------------- - - | Default: ``True`` - - This is a `django-allauth setting `__ - It allows specifying the HTTP method used when confirming e-mail addresses. - -ACCOUNT_EMAIL_REQUIRED ----------------------- - - | Default: ``True`` - - This is a `django-allauth setting `__ - which controls whether the user is required to provide an e-mail address upon registration. - -ACCOUNT_EMAIL_VERIFICATION --------------------------- - - | Default: ``optional`` - - This is a `django-allauth setting `__ - -ACCOUNT_LOGIN_REDIRECT_URL --------------------------- - - | Default: ``SITEURL`` - | Env: ``LOGIN_REDIRECT_URL`` - - This is a `django-user-accounts setting `__ - It allows specifying the default redirect URL after a successful login. - -ACCOUNT_LOGOUT_REDIRECT_URL ---------------------------- - - | Default: ``SITEURL`` - | Env: ``LOGOUT_REDIRECT_URL`` - - This is a `django-user-accounts setting `__ - It allows specifying the default redirect URL after a successful logout. - -ACCOUNT_NOTIFY_ON_PASSWORD_CHANGE ---------------------------------- - - | Default: ``True`` - | Env: ``ACCOUNT_NOTIFY_ON_PASSWORD_CHANGE`` - - This is a `django-user-accounts setting `__ - -ACCOUNT_OPEN_SIGNUP -------------------- - - | Default: ``True`` - | Env: ``ACCOUNT_OPEN_SIGNUP`` - - This is a `django-user-accounts setting `__ - Whether or not people are allowed to self-register to GeoNode or not. - -ACCOUNT_SIGNUP_FORM_CLASS -------------------------- - - | Default: ``geonode.people.forms.AllauthReCaptchaSignupForm`` - | Env: ``ACCOUNT_SIGNUP_FORM_CLASS`` - - Enabled only when the :ref:`recaptcha_enabled` option is ``True``. - - Ref. to :ref:`recaptcha_enabled` - -ACTSTREAM_SETTINGS ------------------- - - Default:: - - { - 'FETCH_RELATIONS': True, - 'USE_PREFETCH': False, - 'USE_JSONFIELD': True, - 'GFK_FETCH_DEPTH': 1, - } - - Actstream Settings. - -ADMIN_MODERATE_UPLOADS ----------------------- - - | Default: ``False`` - - When this variable is set to ``True``, every uploaded resource must be approved before becoming visible to the public users. - - Until a resource is in ``PENDING APPROVAL`` state, only the superusers, owner and group members can access it, unless specific edit permissions have been set for other users or groups. - - A ``Group Manager`` *can* approve the resource, but he cannot publish it whenever the setting ``RESOURCE_PUBLISHING`` is set to ``True``. - Otherwise, if ``RESOURCE_PUBLISHING`` is set to ``False``, the resource becomes accessible as soon as it is approved. - -ALLOWED_DOCUMENT_TYPES ----------------------- - - Default:: - - ['doc', 'docx', 'gif', 'jpg', 'jpeg', 'ods', 'odt', 'odp', 'pdf', 'png', - 'ppt', 'pptx', 'rar', 'sld', 'tif', 'tiff', 'txt', 'xls', 'xlsx', 'xml', - 'zip', 'gz', 'qml'] - - A list of acceptable file extensions that can be uploaded to the Documents app. - -ANONYMOUS_USER_ID ------------------ - - | Default: ``-1`` - | Env: ``ANONYMOUS_USER_ID`` - - The id of an anonymous user. This is an django-guardian setting. - -API_INCLUDE_REGIONS_COUNT -------------------------- - - | Default: ``False`` - | Env: ``API_INCLUDE_REGIONS_COUNT`` - - If set to ``True``, a counter with the total number of available regions will be added to the API JSON Serializer. - -API_LIMIT_PER_PAGE ------------------- - - | Default: ``200`` - | Env: ``API_LIMIT_PER_PAGE`` - - The Number of items returned by the APIs 0 equals no limit. Different from ``CLIENT_RESULTS_LIMIT``, affecting the number of items per page in the resource list. - -API_LOCKDOWN ------------- - - | Default: ``False`` - | Env: ``API_LOCKDOWN`` - - If this is set to ``True`` users must be authenticated to get search results when search for for users, groups, categories, regions, tags etc. - Filtering search results of Resourcebase-objects like Layers, Maps or Documents by one of the above types does not work. - Attention: If API_LOCKDOWN is set to ``False`` all details can be accessed by anonymous users. - -ASYNC_SIGNALS -------------- - - | Default: ``False`` - | Env: ``ACCOUNT_NOTIFY_ON_PASSWORD_CHANGE`` - -AUTH_EXEMPT_URLS ----------------- - - Default:: - - (r'^/?$', - '/gs/*', - '/static/*', - '/o/*', - '/api/o/*', - '/api/roles', - '/api/adminRole', - '/api/users', - '/api/layers',) - - A tuple of URL patterns that the user can visit without being authenticated. - This setting has no effect if ``LOCKDOWN_GEONODE`` is not True. For example, - ``AUTH_EXEMPT_URLS = ('/maps',)`` will allow unauthenticated users to - browse maps. - -AUTO_ASSIGN_REGISTERED_MEMBERS_TO_REGISTERED_MEMBERS_GROUP_NAME ---------------------------------------------------------------- - - | Default: ``True`` - | Env: ``AUTO_ASSIGN_REGISTERED_MEMBERS_TO_REGISTERED_MEMBERS_GROUP_NAME`` - - Auto assign users to a default ``REGISTERED_MEMBERS_GROUP_NAME`` private group after ``AUTO_ASSIGN_REGISTERED_MEMBERS_TO_REGISTERED_MEMBERS_GROUP_AT``. - -AUTO_ASSIGN_REGISTERED_MEMBERS_TO_REGISTERED_MEMBERS_GROUP_AT -------------------------------------------------------------- - - | Default: ``activation`` - | Env: ``AUTO_ASSIGN_REGISTERED_MEMBERS_TO_REGISTERED_MEMBERS_GROUP_AT`` - | Options: ``"registration" | "activation" | "login"`` - - Auto assign users to a default ``REGISTERED_MEMBERS_GROUP_NAME`` private group after {"registration" | "activation" | "login"}. - - Notice that whenever ``ACCOUNT_EMAIL_VERIFICATION == True`` and ``ACCOUNT_APPROVAL_REQUIRED == False``, users will be able to register and they became ``active`` already, even if they won't be able to login until the email has been verified. - -AUTO_GENERATE_AVATAR_SIZES --------------------------- - - | Default: ``20, 30, 32, 40, 50, 65, 70, 80, 100, 140, 200, 240`` - - An iterable of integers representing the sizes of avatars to generate on upload. This can save rendering time later on if you pre-generate the resized versions. - -AWS_ACCESS_KEY_ID ------------------ - - | Default: ``''`` - | Env: ``AWS_ACCESS_KEY_ID`` - - This is a `Django storage setting `__ - Your Amazon Web Services access key, as a string. - - .. warning:: This works only if ``DEBUG = False`` - -AWS_BUCKET_NAME ---------------- - - | Default: ``''`` - | Env: ``S3_BUCKET_NAME`` - - The name of the S3 bucket GeoNode will pull static and/or media files from. Set through the environment variable S3_BUCKET_NAME. - This is a `Django storage setting `__ - - .. warning:: This works only if ``DEBUG = False`` - -AWS_QUERYSTRING_AUTH --------------------- - - | Default: ``False`` - - This is a `Django storage setting `__ - Setting AWS_QUERYSTRING_AUTH to False to remove query parameter authentication from generated URLs. This can be useful if your S3 buckets are public. - - .. warning:: This works only if ``DEBUG = False`` - -AWS_S3_BUCKET_DOMAIN --------------------- - - https://github.com/GeoNode/geonode/blob/master/geonode/settings.py#L1661 - ``AWS_S3_BUCKET_DOMAIN = '%s.s3.amazonaws.com' % AWS_STORAGE_BUCKET_NAME`` - - .. warning:: This works only if ``DEBUG = False`` - -AWS_SECRET_ACCESS_KEY ---------------------- - - | Default: ``''`` - | Env: ``AWS_SECRET_ACCESS_KEY`` - - This is a `Django storage setting `__ - Your Amazon Web Services secret access key, as a string. - - .. warning:: This works only if ``DEBUG = False`` - -AWS_STORAGE_BUCKET_NAME ------------------------ - - | Default: ``''`` - | Env: ``S3_BUCKET_NAME`` - - This is a `Django storage setting `__ - Your Amazon Web Services storage bucket name, as a string. - - .. warning:: This works only if ``DEBUG = False`` - -B -= - -BING_API_KEY ------------- - - | Default: ``None`` - | Env: ``BING_API_KEY`` - - This property allows to enable a Bing Aerial background. - - If using ``mapstore`` client library, make sure the ``MAPSTORE_BASELAYERS`` include the following: - - .. code-block:: python - - if BING_API_KEY: - BASEMAP = { - "type": "bing", - "title": "Bing Aerial", - "name": "AerialWithLabels", - "source": "bing", - "group": "background", - "apiKey": "{{apiKey}}", - "visibility": False - } - DEFAULT_MS2_BACKGROUNDS = [BASEMAP,] + DEFAULT_MS2_BACKGROUNDS - - If using ``geoext`` client library, make sure the ``MAP_BASELAYERS`` include the following: - - .. code-block:: python - - if BING_API_KEY: - BASEMAP = { - 'source': { - 'ptype': 'gxp_bingsource', - 'apiKey': BING_API_KEY - }, - 'name': 'AerialWithLabels', - 'fixed': True, - 'visibility': True, - 'group': 'background' - } - MAP_BASELAYERS.append(BASEMAP) - - -BROKER_HEARTBEAT ----------------- - - | Default: ``0`` - - Heartbeats are used both by the client and the broker to detect if a connection was closed. - This is a `Celery setting `__. - - -BROKER_TRANSPORT_OPTIONS ------------------------- - - Default:: - - { - 'fanout_prefix': True, - 'fanout_patterns': True, - 'socket_timeout': 60, - 'visibility_timeout': 86400 - } - - This is a `Celery setting `__. - - -C -= - -CACHES ------- - - Default:: - - CACHES = { - 'default': { - 'BACKEND': 'django.core.cache.backends.dummy.DummyCache', - }, - 'resources': { - 'BACKEND': 'django.core.cache.backends.locmem.LocMemCache', - 'TIMEOUT': 600, - 'OPTIONS': { - 'MAX_ENTRIES': 10000 - } - } - } - - A dictionary containing the settings for all caches to be used with Django. - This is a `Django setting `__ - - The ``'default'`` cache is disabled because we don't have a mechanism to discriminate between client sesssions right now, and we don't want all users fetch the same api results. - - The ``'resources'`` is not currently used. It might be helpful for `caching Django template fragments `__ and/or `Tastypie API Caching `__. - - -CACHE_BUSTING_MEDIA_ENABLED ---------------------------- - - | Default: ``False`` - | Env: ``CACHE_BUSTING_MEDIA_ENABLED`` - - This is a `Django ManifestStaticFilesStorage storage setting `__ - A boolean allowing you to enable the ``ManifestStaticFilesStorage storage``. This works only on a production system. - - .. warning:: This works only if ``DEBUG = False`` - -CACHE_BUSTING_STATIC_ENABLED ----------------------------- - - | Default: ``False`` - | Env: ``CACHE_BUSTING_STATIC_ENABLED`` - - This is a `Django ManifestStaticFilesStorage storage setting `__ - A boolean allowing you to enable the ``ManifestStaticFilesStorage storage``. This works only on a production system. - - .. warning:: This works only if ``DEBUG = False`` - - -CASCADE_WORKSPACE ------------------ - - | Default: ``geonode`` - | Env: ``CASCADE_WORKSPACE`` - - -CATALOGUE ---------- - - A dict with the following keys: - - ENGINE: The CSW backend (default is ``geonode.catalogue.backends.pycsw_local``) - URL: The FULLY QUALIFIED base URL to the CSW instance for this GeoNode - USERNAME: login credentials (if required) - PASSWORD: login credentials (if required) - - pycsw is the default CSW enabled in GeoNode. pycsw configuration directives - are managed in the PYCSW entry. - -CELERYD_POOL_RESTARTS ---------------------- - - Default: ``True`` - - This is a `Celery setting `__. - -CELERY_ACCEPT_CONTENT ---------------------- - - Defaul: ``['json']`` - - This is a `Celery setting `__. - -CELERY_ACKS_LATE ----------------- - - Default: ``True`` - - This is a `Celery setting `__ - -CELERY_BEAT_SCHEDULE --------------------- - - Here you can define your scheduled task. - -CELERY_DISABLE_RATE_LIMITS --------------------------- - - Default: ``False`` - - This is a `Celery setting `__. - -CELERY_ENABLE_UTC ------------------ - - Default: ``True`` - - This is a `Celery setting `__. - -CELERY_MAX_CACHED_RESULTS -------------------------- - - Default: ``32768`` - - This is a `Celery setting `__. - -CELERY_MESSAGE_COMPRESSION --------------------------- - - Default: ``gzip`` - - This is a `Celery setting `__. - -CELERY_RESULT_PERSISTENT ------------------------- - - Default: ``False`` - - This is a `Celery setting `__. - -CELERY_RESULT_SERIALIZER ------------------------- - - Default: ``json`` - - This is a `Celery setting `__. - -CELERY_SEND_TASK_SENT_EVENT ---------------------------- - - Default: ``True`` - - If enabled, a task-sent event will be sent for every task so tasks can be tracked before they are consumed by a worker. This is a `Celery setting `__. - - -CELERY_TASK_ALWAYS_EAGER ------------------------- - - Default: ``False if ASYNC_SIGNALS else True`` - - This is a `Celery setting `__. - -CELERY_TASK_CREATE_MISSING_QUEUES ---------------------------------- - - Default: ``True`` - - This is a `Celery setting `__. - -CELERY_TASK_IGNORE_RESULT -------------------------- - - Default: ``True`` - - This is a `Celery setting `__. - -CELERY_TASK_QUEUES ------------------- - - Default:: - - Queue('default', GEONODE_EXCHANGE, routing_key='default'), - Queue('geonode', GEONODE_EXCHANGE, routing_key='geonode'), - Queue('update', GEONODE_EXCHANGE, routing_key='update'), - Queue('cleanup', GEONODE_EXCHANGE, routing_key='cleanup'), - Queue('email', GEONODE_EXCHANGE, routing_key='email'), - - A tuple with registered Queues. - -CELERY_TASK_RESULT_EXPIRES --------------------------- - - Default: ``43200`` - - This is a `Celery setting `__. - -CELERY_TASK_SERIALIZER ----------------------- - - Default: ``json`` - - This is a `Celery setting `__. - -CELERY_TIMEZONE ---------------- - - | Default: ``UTC`` - | Env: ``TIME_ZONE`` - - This is a `Celery setting `__. - -CELERY_TRACK_STARTED --------------------- - - Default: ``True`` - - This is a `Celery setting `__. - -CELERY_WORKER_DISABLE_RATE_LIMITS ---------------------------------- - - Default: ``False`` - - Disable the worker rate limits (number of tasks that can be run in a given time frame). - -CELERY_WORKER_SEND_TASK_EVENTS ------------------------------- - - Default: ``False`` - - Send events so the worker can be monitored by other tools. - -CLIENT_RESULTS_LIMIT --------------------- - - | Default: ``20`` - | Env: ``CLIENT_RESULTS_LIMIT`` - - The Number of results per page listed in the GeoNode search pages. Different from ``API_LIMIT_PER_PAGE``, affecting the number of items returned by the APIs. - -CREATE_LAYER ------------- - - Default: ``False`` - - Enable the create layer plugin. - -CKAN_ORIGINS ------------- - - Default:: - - CKAN_ORIGINS = [{ - "label":"Humanitarian Data Exchange (HDX)", - "url":"https://data.hdx.rwlabs.org/dataset/new?title={name}¬es={abstract}", - "css_class":"hdx" - }] - - A list of dictionaries that are used to generate the links to CKAN instances displayed in the Share tab. For each origin, the name and abstract format parameters are replaced by the actual values of the ResourceBase object (layer, map, document). This is not enabled by default. To enable, uncomment the following line: SOCIAL_ORIGINS.extend(CKAN_ORIGINS). - -CSRF_COOKIE_HTTPONLY --------------------- - - | Default: `False` - | Env: `CSRF_COOKIE_HTTPONLY` - - Whether to use HttpOnly flag on the CSRF cookie. If this is set to True, client-side JavaScript will not be able to access the CSRF cookie. This is a `Django Setting `__ - -CSRF_COOKIE_SECURE ------------------- - - | Default: `False` - | Env: `CSRF_COOKIE_HTTPONLY` - - Whether to use a secure cookie for the CSRF cookie. If this is set to True, the cookie will be marked as “secure,” which means browsers may ensure that the cookie is only sent with an HTTPS connection. This is a `Django Setting `__ - -D -= - -DATA_UPLOAD_MAX_NUMBER_FIELDS ------------------------------ - - Default: `100000` - - Maximum value of parsed attributes. - -DEBUG ------ - - Default: `False` - - One of the main features of debug mode is the display of detailed error pages. If your app raises an exception when DEBUG is True, Django will display a detailed traceback, including a lot of metadata about your environment, such as all the currently defined Django settings (from settings.py). - This is a `Django Setting `__ - - -DEBUG_STATIC ------------- - - Default: `False` - - Load non minified version of static files. - -DEFAULT_ANONYMOUS_DOWNLOAD_PERMISSION -------------------------------------- - - Default: `True` - - Whether the uploaded resources should downloadable by default. - -DEFAULT_ANONYMOUS_VIEW_PERMISSION ---------------------------------- - - Default: `True` - - Whether the uploaded resources should be public by default. - -DEFAULT_LAYER_FORMAT --------------------- - - | Default: `image/png` - | Env: `DEFAULT_LAYER_FORMAT` - - The default format for requested tile images. - - -DEFAULT_MAP_CENTER ------------------- - - | Default: ``(0, 0)`` - | Env: ``DEFAULT_MAP_CENTER_X`` ``DEFAULT_MAP_CENTER_Y`` - - A 2-tuple with the latitude/longitude coordinates of the center-point to use - in newly created maps. - -DEFAULT_MAP_CRS ---------------- - - | Default: ``EPSG:3857`` - | Env: ``DEFAULT_MAP_CRS`` - - The default map projection. Default: EPSG:3857 - -DEFAULT_MAP_ZOOM ----------------- - - | Default: ``0`` - | Env: ``DEFAULT_MAP_ZOOM`` - - The zoom-level to use in newly created maps. This works like the OpenLayers - zoom level setting; 0 is at the world extent and each additional level cuts - the viewport in half in each direction. - -DEFAULT_SEARCH_SIZE -------------------- - - | Default: ``10`` - | Env: ``DEFAULT_SEARCH_SIZE`` - - An integer that specifies the default search size when using ``geonode.search`` for querying data. - -DEFAULT_WORKSPACE ------------------ - - | Default: ``geonode`` - | Env: ``DEFAULT_WORKSPACE`` - - The standard GeoServer workspace. - -DELAYED_SECURITY_SIGNALS ------------------------- - - | Default: ``False`` - | Env: ``DELAYED_SECURITY_SIGNALS`` - - This setting only works when ``GEOFENCE_SECURITY_ENABLED`` has been set to ``True`` and GeoNode is making use of the ``GeoServer BACKEND``. - - By setting this to ``True``, every time the permissions will be updated/changed for a Layer, they won't be applied immediately but only and only if - either: - - a. A Celery Worker is running and it is able to execute the ``geonode.security.tasks.synch_guardian`` periodic task; - notice that the task will be executed at regular intervals, based on the interval value defined in the corresponding PeriodicTask model. - - b. A periodic ``cron`` job runs the ``sync_security_rules`` management command, or either it is manually executed from the Django shell. - - c. The user, owner of the Layer or with rights to change its permissions, clicks on the GeoNode UI button ``Sync permissions immediately`` - - .. warning:: Layers won't be accessible to public users anymore until the Security Rules are not synchronized! - -DISPLAY_COMMENTS ----------------- - - | Default: ``True`` - | Env: ``DISPLAY_COMMENTS`` - - If set to False comments are hidden. - - -DISPLAY_RATINGS ---------------- - - | Default: ``True`` - | Env: ``DISPLAY_RATINGS`` - - If set to False ratings are hidden. - -DISPLAY_SOCIAL --------------- - - | Default: ``True`` - | Env: ``DISPLAY_SOCIAL`` - - If set to False social sharing is hidden. - -DISPLAY_WMS_LINKS ------------------ - - | Default: ``True`` - | Env: ``DISPLAY_WMS_LINKS`` - - If set to False direct WMS link to GeoServer is hidden. - -DISPLAY_ORIGINAL_DATASET_LINK ------------------------------ - - | Default: ``True`` - | Env: ``DISPLAY_ORIGINAL_DATASET_LINK`` - - If set to False original dataset download is hidden. - -DOWNLOAD_FORMATS_METADATA -------------------------- - - Specifies which metadata formats are available for users to download. - - Default:: - - DOWNLOAD_FORMATS_METADATA = [ - 'Atom', 'DIF', 'Dublin Core', 'ebRIM', 'FGDC', 'ISO', - ] - -DOWNLOAD_FORMATS_VECTOR ------------------------ - - Specifies which formats for vector data are available for users to download. - - Default:: - - DOWNLOAD_FORMATS_VECTOR = [ - 'JPEG', 'PDF', 'PNG', 'Zipped Shapefile', 'GML 2.0', 'GML 3.1.1', 'CSV', - 'Excel', 'GeoJSON', 'KML', 'View in Google Earth', 'Tiles', - ] - -DOWNLOAD_FORMATS_RASTER ------------------------ - - Specifies which formats for raster data are available for users to download. - - Default:: - - DOWNLOAD_FORMATS_RASTER = [ - 'JPEG', 'PDF', 'PNG' 'Tiles', - ] - -E -= - -EMAIL_ENABLE ------------- - - | Default: ``False`` - - Options: - - * EMAIL_BACKEND - - Default: ``django.core.mail.backends.smtp.EmailBackend`` - - Env: ``DJANGO_EMAIL_BACKEND`` - - * EMAIL_HOST - - Default: ``localhost`` - - * EMAIL_PORT - - Default: ``25`` - - * EMAIL_HOST_USER - - Default: ``''`` - - * EMAIL_HOST_PASSWORD - - Default: ``''`` - - * EMAIL_USE_TLS - - Default: ``False`` - - * DEFAULT_FROM_EMAIL - - Default: ``GeoNode `` - -EPSG_CODE_MATCHES ------------------ - - | Default: - - .. code-block:: python - - { - 'EPSG:4326': '(4326) WGS 84', - 'EPSG:900913': '(900913) Google Maps Global Mercator', - 'EPSG:3857': '(3857) WGS 84 / Pseudo-Mercator', - 'EPSG:3785': '(3785 DEPRECATED) Popular Visualisation CRS / Mercator', - 'EPSG:32647': '(32647) WGS 84 / UTM zone 47N', - 'EPSG:32736': '(32736) WGS 84 / UTM zone 36S' - } - - Supported projections human readbale descriptions associated to their EPSG Codes. - This list will be presented to the user during the upload process whenever GeoNode won't be able to recognize a suitable projection. - Those codes should be aligned to the `UPLOADER` ones and available in GeoServer also. - -F -= - -FREETEXT_KEYWORDS_READONLY --------------------------- - - | Default: ``False`` - | Env: ``FREETEXT_KEYWORDS_READONLY`` - - Make Free-Text Keywords writable from users. Or read-only when set to False. - -G -= - -GEOFENCE_SECURITY_ENABLED -------------------------- - - | Default: ``True`` (False is Test is true) - | Env: ``GEOFENCE_SECURITY_ENABLED`` - - Whether the geofence security system is used. - -GEOIP_PATH ----------- - - | Default: ``Path to project`` - | Env: ``PROJECT_ROOT`` - - The local path where GeoIPCities.dat is written to. Make sure your user has to have write permissions. - - -GEONODE_APPS ------------- - - If enabled contrib apps are used. - -GEONODE_CLIENT_LAYER_PREVIEW_LIBRARY ------------------------------------- - - Default: ``"mapstore"`` - - The library to use for display preview images of layers. The library choices are: - - ``"mapstore"`` - ``"geoext"`` - ``"leaflet"`` - ``"react"`` - -GEONODE_EXCHANGE ----------------- - - | Default:: ``Exchange("default", type="direct", durable=True)`` - - The definition of Exchanges published by geonode. Find more about Exchanges at `celery docs `__. - - -GEOSERVER_EXCHANGE ------------------- - - | Default:: ``Exchange("geonode", type="topic", durable=False)`` - - The definition of Exchanges published by GeoServer. Find more about Exchanges at `celery docs `__. - -GEOSERVER_LOCATION ------------------- - - | Default: ``http://localhost:8080/geoserver/`` - | Env: ``GEOSERVER_LOCATION`` - - Url under which GeoServer is available. - -GEOSERVER_PUBLIC_HOST ---------------------- - - | Default: ``SITE_HOST_NAME`` (Variable) - | Env: ``GEOSERVER_PUBLIC_HOST`` - - Public hostname under which GeoServer is available. - -GEOSERVER_PUBLIC_LOCATION -------------------------- - - | Default: ``SITE_HOST_NAME`` (Variable) - | Env: ``GEOSERVER_PUBLIC_LOCATION`` - - Public location under which GeoServer is available. - -GEOSERVER_PUBLIC_PORT ---------------------- - - | Default: ``8080 (Variable)`` - | Env: ``GEOSERVER_PUBLIC_PORT`` - - - Public Port under which GeoServer is available. - -GEOSERVER_WEB_UI_LOCATION -------------------------- - - | Default: ``GEOSERVER_PUBLIC_LOCATION (Variable)`` - | Env: ``GEOSERVER_WEB_UI_LOCATION`` - - Public location under which GeoServer is available. - -GROUP_PRIVATE_RESOURCES ------------------------ - - | Default: ``False`` - | Env: ``GROUP_PRIVATE_RESOURCES`` - - If this option is enabled, Resources belonging to a Group won't be visible by others - -H -= - -HAYSTACK_FACET_COUNTS ---------------------- - - | Default: ``True`` - | Env: ``HAYSTACK_FACET_COUNTS`` - - If set to True users will be presented with feedback about the number of resources which matches terms they may be interested in. - -HAYSTACK_SEARCH ---------------- - - | Default: ``False`` - | Env: ``HAYSTACK_SEARCH`` - - Enable/disable haystack Search Backend Configuration. - - -L -= - -LEAFLET_CONFIG --------------- - - A dictionary used for Leaflet configuration. - -LICENSES --------- - - | Default:: - - { - 'ENABLED': True, - 'DETAIL': 'above', - 'METADATA': 'verbose', - } - - Enable Licenses User Interface - -LOCAL_SIGNALS_BROKER_URL ------------------------- - - | Default: ``memory://`` - -LOCKDOWN_GEONODE ----------------- - - | Default: ``False`` - | Env: ``LOCKDOWN_GEONODE`` - - By default, the GeoNode application allows visitors to view most pages without being authenticated. If this is set to ``True`` - users must be authenticated before accessing URL routes not included in ``AUTH_EXEMPT_URLS``. - -LOGIN_URL ---------- - - | Default: ``{}account/login/'.format(SITEURL)`` - | Env: ``LOGIN_URL`` - - The URL where requests are redirected for login. - - -LOGOUT_URL ----------- - - | Default: ``{}account/login/'.format(SITEURL)`` - | Env: ``LOGOUT_URL`` - - The URL where requests are redirected for logout. - -M -= - -MAP_CLIENT_USE_CROSS_ORIGIN_CREDENTIALS ---------------------------------------- - - | Default: ``False`` - | Env: ``MAP_CLIENT_USE_CROSS_ORIGIN_CREDENTIALS`` - - Enables cross origin requests for geonode-client. - -MAPSTORE_BASELAYERS -------------------- - - | Default: - - .. code-block:: python - - [ - { - "type": "osm", - "title": "Open Street Map", - "name": "mapnik", - "source": "osm", - "group": "background", - "visibility": True - }, { - "type": "tileprovider", - "title": "OpenTopoMap", - "provider": "OpenTopoMap", - "name": "OpenTopoMap", - "source": "OpenTopoMap", - "group": "background", - "visibility": False - }, { - "type": "wms", - "title": "Sentinel-2 cloudless - https://s2maps.eu", - "format": "image/jpeg", - "id": "s2cloudless", - "name": "s2cloudless:s2cloudless", - "url": "https://maps.geo-solutions.it/geoserver/wms", - "group": "background", - "thumbURL": "%sstatic/mapstorestyle/img/s2cloudless-s2cloudless.png" % SITEURL, - "visibility": False - }, { - "source": "ol", - "group": "background", - "id": "none", - "name": "empty", - "title": "Empty Background", - "type": "empty", - "visibility": False, - "args": ["Empty Background", {"visibility": False}] - } - ] - - | Env: ``MAPSTORE_BASELAYERS`` - - Allows to specify which backgrounds MapStore should use. The parameter ``visibility`` for a layer, specifies which one is the default one. - - A sample configuration using the Bing background witouhg OpenStreetMap, could be the following one: - - .. code-block:: python - - [ - { - "type": "bing", - "title": "Bing Aerial", - "name": "AerialWithLabels", - "source": "bing", - "group": "background", - "apiKey": "{{apiKey}}", - "visibility": True - }, { - "type": "tileprovider", - "title": "OpenTopoMap", - "provider": "OpenTopoMap", - "name": "OpenTopoMap", - "source": "OpenTopoMap", - "group": "background", - "visibility": False - }, { - "type": "wms", - "title": "Sentinel-2 cloudless - https://s2maps.eu", - "format": "image/jpeg", - "id": "s2cloudless", - "name": "s2cloudless:s2cloudless", - "url": "https://maps.geo-solutions.it/geoserver/wms", - "group": "background", - "thumbURL": "%sstatic/mapstorestyle/img/s2cloudless-s2cloudless.png" % SITEURL, - "visibility": False - }, { - "source": "ol", - "group": "background", - "id": "none", - "name": "empty", - "title": "Empty Background", - "type": "empty", - "visibility": False, - "args": ["Empty Background", {"visibility": False}] - } - ] - - .. warning:: To use a Bing background, you need to correctly set and provide a valid ``BING_API_KEY`` - -MAX_DOCUMENT_SIZE ------------------ - - | Default:``2`` - | Env: ``MAX_DOCUMENT_SIZE`` - - Allowed size for documents in MB. - -MISSING_THUMBNAIL ------------------ - - Default: ``geonode/img/missing_thumb.png`` - - The path to an image used as thumbnail placeholder. - -MODIFY_TOPICCATEGORY --------------------- - - Default: ``False`` - - Metadata Topic Categories list should not be modified, as it is strictly defined - by ISO (See: http://www.isotc211.org/2005/resources/Codelist/gmxCodelists.xml - and check the element). - - Some customization is still possible changing the is_choice and the GeoNode - description fields. - - In case it is necessary to add/delete/update categories, it is - possible to set the MODIFY_TOPICCATEGORY setting to True. - -MONITORING_ENABLED ------------------- - - Default: ``False`` - - Enable internal monitoring application (`geonode.monitoring`). If set to `True`, add following code to your local settings: - - .. code:: - - MONITORING_ENABLED = True - # add following lines to your local settings to enable monitoring - if MONITORING_ENABLED: - INSTALLED_APPS + ('geonode.monitoring',) - MIDDLEWARE_CLASSES + ('geonode.monitoring.middleware.MonitoringMiddleware',) - - See :ref:`geonode_monitoring` for details. - -.. _monitoring-data-aggregation: - -MONITORING_DATA_AGGREGATION ---------------------------- - - Default: - - .. code:: - - ( - (timedelta(seconds=0), timedelta(minutes=1),), - (timedelta(days=1), timedelta(minutes=60),), - (timedelta(days=14), timedelta(days=1),), - ) - - Configure aggregation of past data to control data resolution. It lists data age and aggregation in reverse order, by default: - - | - for current data, 1 minute resolution - | - for data older than 1 day, 1-hour resolution - | - for data older than 2 weeks, 1 day resolution - - See :ref:`geonode_monitoring` for further details. - - This setting takes effects only if :ref:`user-analytics` is true. - -MONITORING_DATA_TTL -------------------- - - | Default: ``7`` - | Env: ``MONITORING_DATA_TTL`` - - How long monitoring data should be stored in days. - -MONITORING_DISABLE_CSRF ------------------------ - - | Default: ``False`` - | Env: ``MONITORING_DISABLE_CSRF`` - - Set this to true to disable csrf check for notification config views, use with caution - for dev purpose only. - -.. _monitoring-skip-paths: - -MONITORING_SKIP_PATHS ------------------------ - - Default: - - .. code:: - - ( - '/api/o/', - '/monitoring/', - '/admin', - '/jsi18n', - STATIC_URL, - MEDIA_URL, - re.compile('^/[a-z]{2}/admin/'), - ) - - Skip certain useless paths to not to mud analytics stats too much. - See :ref:`geonode_monitoring` to learn more about it. - - This setting takes effects only if :ref:`user-analytics` is true. - -N -= - -NOTIFICATIONS_MODULE --------------------- - - Default: ``pinax.notifications`` - - App used for notifications. (pinax.notifications or notification) - -NOTIFICATION_ENABLED --------------------- - - | Default: ``True`` - | Env: ``NOTIFICATION_ENABLED`` - - Enable or disable the notification system. - -O -= - -OAUTH2_API_KEY --------------- - - | Default: ``None`` - | Env: ``OAUTH2_API_KEY`` - - In order to protect oauth2 REST endpoints, used by GeoServer to fetch user roles and infos, you should set this key and configure the ``geonode REST role service`` accordingly. Keep it secret! - - .. warning:: If not set, the endpoint can be accessed by users without authorization. - -OAUTH2_PROVIDER ---------------- - - Ref.: `OAuth Toolkit settings `__ - -OAUTH2_PROVIDER_APPLICATION_MODEL ---------------------------------- - - | Default: ``oauth2_provider.Application`` - - Ref.: `OAuth Toolkit settings `__ - -OAUTH2_PROVIDER_ACCESS_TOKEN_MODEL ----------------------------------- - - | Default: ``oauth2_provider.AccessToken`` - - Ref.: `OAuth Toolkit settings `__ - -OAUTH2_PROVIDER_ID_TOKEN_MODEL ------------------------------- - - | Default: ``oauth2_provider.IDToken`` - - Ref.: `OAuth Toolkit settings `__ - -OAUTH2_PROVIDER_GRANT_MODEL ---------------------------- - - | Default: ``oauth2_provider.Grant`` - - Ref.: `OAuth Toolkit settings `__ - -OAUTH2_PROVIDER_REFRESH_TOKEN_MODEL ------------------------------------ - - | Default: ``oauth2_provider.RefreshToken`` - - Ref.: `OAuth Toolkit settings `__ - -OGC_SERVER_DEFAULT_PASSWORD ---------------------------- - - | Default: ``geoserver`` - | Env: ``GEOSERVER_ADMIN_PASSWORD`` - - The geoserver password. - -OGC_SERVER_DEFAULT_USER ------------------------ - - | Default: ``admin`` - | Env: ``GEOSERVER_ADMIN_USER`` - - The GeoServer user. - -OGC_SERVER ----------- - - Default: ``{}`` (Empty dictionary) - - A dictionary of OGC servers and their options. The main - server should be listed in the 'default' key. If there is no 'default' - key or if the ``OGC_SERVER`` setting does not exist, Geonode will raise - an Improperly Configured exception. Below is an example of the ``OGC_SERVER`` - setting:: - - OGC_SERVER = { - 'default' : { - 'LOCATION' : 'http://localhost:8080/geoserver/', - 'USER' : 'admin', - 'PASSWORD' : 'geoserver', - } - } - - * BACKEND - - Default: ``"geonode.geoserver"`` - - The OGC server backend to use. The backend choices are: - - ``'geonode.geoserver'`` - - * BACKEND_WRITE_ENABLED - - Default: ``True`` - - Specifies whether the OGC server can be written to. If False, actions that modify - data on the OGC server will not execute. - - * DATASTORE - - Default: ``''`` (Empty string) - - An optional string that represents the name of a vector datastore, where Geonode uploads are imported into. To support vector datastore imports there also needs to be an - entry for the datastore in the ``DATABASES`` dictionary with the same name. Example:: - - OGC_SERVER = { - 'default' : { - 'LOCATION' : 'http://localhost:8080/geoserver/', - 'USER' : 'admin', - 'PASSWORD' : 'geoserver', - 'DATASTORE': 'geonode_imports' - } - } - - DATABASES = { - 'default': { - 'ENGINE': 'django.db.backends.sqlite3', - 'NAME': 'development.db', - }, - 'geonode_imports' : { - 'ENGINE': 'django.contrib.gis.db.backends.postgis', - 'NAME': 'geonode_imports', - 'USER' : 'geonode_user', - 'PASSWORD' : 'a_password', - 'HOST' : 'localhost', - 'PORT' : '5432', - } - } - - * GEONODE_SECURITY_ENABLED - - Default: ``True`` - - A boolean that represents whether GeoNode's security application is enabled. - - * LOCATION - - Default: ``"http://localhost:8080/geoserver/"`` - - A base URL from which GeoNode can construct OGC service URLs. - If using GeoServer you can determine this by - visiting the GeoServer administration home page without the - /web/ at the end. For example, if your GeoServer administration app is at - http://example.com/geoserver/web/, your server's location is http://example.com/geoserver. - - * MAPFISH_PRINT_ENABLED - - Default: ``True`` - - A boolean that represents whether the MapFish printing extension is enabled on the server. - - * PASSWORD - - Default: ``'geoserver'`` - - The administrative password for the OGC server as a string. - - * PRINT_NG_ENABLED - - Default: ``True`` - - A boolean that represents whether printing of maps and layers is enabled. - - * PUBLIC_LOCATION - - Default: ``"http://localhost:8080/geoserver/"`` - - The URL used to in most public requests from Geonode. This setting allows a user to write to one OGC server (the LOCATION setting) - and read from a separate server or the PUBLIC_LOCATION. - - * USER - - Default: ``'admin'`` - - The administrative username for the OGC server as a string. - - * WMST_ENABLED - - Default: ``False`` - - Not implemented. - - * WPS_ENABLED - - Default: ``False`` - - Not implemented. - - * TIMEOUT - - Default: ``10`` - - The maximum time, in seconds, to wait for the server to respond. - -OGP_URL -------- - - | Default: ``http://geodata.tufts.edu/solr/select`` - | Env: ``OGP_URL`` - - Endpoint of geodata.tufts.edu getCapabilities. - -OPENGRAPH_ENABLED ------------------ - - Default:: ``True`` - - A boolean that specifies whether Open Graph is enabled. Open Graph is used by Facebook and Slack. - -P -= - -PINAX_NOTIFICATIONS_BACKENDS ----------------------------- - - Default: ``("email", _EMAIL_BACKEND, 0),`` - - Used notification backend. This is a `pinax notification setting: `__ - -PINAX_NOTIFICATIONS_LOCK_WAIT_TIMEOUT -------------------------------------- - - | Default: ``-1`` - | Env: ``NOTIFICATIONS_LOCK_WAIT_TIMEOUT`` - - It defines how long to wait for the lock to become available. Default of -1 means to never wait for the lock to become available. - This is a `pinax notification setting: `__ - -PINAX_NOTIFICATIONS_QUEUE_ALL ------------------------------ - - | Default: ``-1`` - | Env: ``NOTIFICATIONS_LOCK_WAIT_TIMEOUT`` - - By default, calling notification.send will send the notification immediately, however, if you set this setting to True, then the default behavior of the send method will be to queue messages in the database for sending via the emit_notices command. - This is a `pinax notification setting: `__ - -PINAX_RATINGS_CATEGORY_CHOICES ------------------------------- - - Default:: - - { - "maps.Map": { - "map": "How good is this map?" - }, - "layers.Layer": { - "layer": "How good is this layer?" - }, - "documents.Document": { - "document": "How good is this document?" - } - } - -PROXY_ALLOWED_HOSTS -------------------- - - Default: ``()`` (Empty tuple) - - A tuple of strings representing the host/domain names that GeoNode can proxy requests to. This is a security measure - to prevent an attacker from using the GeoNode proxy to render malicious code or access internal sites. - - Values in this tuple can be fully qualified names (e.g. 'www.geonode.org'), in which case they will be matched against - the request’s Host header exactly (case-insensitive, not including port). A value beginning with a period can be used - as a subdomain wildcard: ``.geonode.org`` will match geonode.org, www.geonode.org, and any other subdomain of - geonode.org. A value of '*' will match anything and is not recommended for production deployments. - - -PROXY_URL ---------- - - Default ``/proxy/?url=`` - - The URL to a proxy that will be used when making client-side requests in GeoNode. By default, the - internal GeoNode proxy is used but administrators may favor using their own, less restrictive proxies. - - -PYCSW ------ - - A dict with pycsw's configuration. Of note are the sections - ``metadata:main`` to set CSW server metadata and ``metadata:inspire`` - to set INSPIRE options. Setting ``metadata:inspire['enabled']`` to ``true`` - will enable INSPIRE support. Server level configurations can be overridden - in the ``server`` section. See http://docs.pycsw.org/en/latest/configuration.html - for full pycsw configuration details. - -R -= - -RABBITMQ_SIGNALS_BROKER_URL ---------------------------- - - Default: ``amqp://localhost:5672`` - - The Rabbitmq endpoint - -.. _recaptcha_enabled: - -RECAPTCHA_ENABLED ------------------ - - | Default: ``False`` - | Env: ``RECAPTCHA_ENABLED`` - - Allows enabling reCaptcha field on signup form. - Valid Captcha Public and Private keys will be needed as specifice here https://pypi.org/project/django-recaptcha/#installation - - More options will be available by enabling this setting: - - * **ACCOUNT_SIGNUP_FORM_CLASS** - - | Default: ``geonode.people.forms.AllauthReCaptchaSignupForm`` - | Env: ``ACCOUNT_SIGNUP_FORM_CLASS`` - - Enabled only when the :ref:`recaptcha_enabled` option is ``True``. - - * **INSTALLED_APPS** - - The ``captcha`` must be present on ``INSTALLED_APPS``, otherwise you'll get an error. - - When enabling the :ref:`recaptcha_enabled` option through the ``environment``, this setting will be automatically added by GeoNode as follows: - - .. code:: python - - if 'captcha' not in INSTALLED_APPS: - INSTALLED_APPS += ('captcha',) - - * **RECAPTCHA_PUBLIC_KEY** - - | Default: ``geonode_RECAPTCHA_PUBLIC_KEY`` - | Env: ``RECAPTCHA_PUBLIC_KEY`` - - In order to generate reCaptcha keys, please see: - - #. https://pypi.org/project/django-recaptcha/#installation - #. https://pypi.org/project/django-recaptcha/#local-development-and-functional-testing - - * **RECAPTCHA_PRIVATE_KEY** - - | Default: ``geonode_RECAPTCHA_PRIVATE_KEY`` - | Env: ``RECAPTCHA_PRIVATE_KEY`` - - In order to generate reCaptcha keys, please see: - - #. https://pypi.org/project/django-recaptcha/#installation - #. https://pypi.org/project/django-recaptcha/#local-development-and-functional-testing - -RECAPTCHA_PUBLIC_KEY --------------------- - - | Default: ``geonode_RECAPTCHA_PUBLIC_KEY`` - | Env: ``RECAPTCHA_PUBLIC_KEY`` - - Ref. to :ref:`recaptcha_enabled` - -RECAPTCHA_PRIVATE_KEY ---------------------- - - | Default: ``geonode_RECAPTCHA_PRIVATE_KEY`` - | Env: ``RECAPTCHA_PRIVATE_KEY`` - - Ref. to :ref:`recaptcha_enabled` - -REDIS_SIGNALS_BROKER_URL ------------------------- - - Default: ``redis://localhost:6379/0`` - - The Redis endpoint. - -REGISTERED_MEMBERS_GROUP_NAME ------------------------------ - - | Default: ``registered-members`` - | Env: ``REGISTERED_MEMBERS_GROUP_NAME`` - - Used by ``AUTO_ASSIGN_REGISTERED_MEMBERS_TO_REGISTERED_MEMBERS_GROUP_NAME`` settings. - -REGISTERED_MEMBERS_GROUP_TITLE ------------------------------- - - | Default: ``Registered Members`` - | Env: ``REGISTERED_MEMBERS_GROUP_TITLE`` - - Used by ``AUTO_ASSIGN_REGISTERED_MEMBERS_TO_REGISTERED_MEMBERS_GROUP_NAME`` settings. - -REGISTRATION_OPEN ------------------ - - Default: ``False`` - - A boolean that specifies whether users can self-register for an account on your site. - -RESOURCE_PUBLISHING -------------------- - - Default: ``False`` - - By default, the GeoNode application allows GeoNode staff members to - publish/unpublish resources. - By default, resources are published when created. When this setting is set to - True the staff members will be able to unpublish a resource (and eventually - publish it back). - -S -= - -S3_MEDIA_ENABLED ----------------- - - | Default: ``False`` - | Env: ``S3_MEDIA_ENABLED`` - - Enable/disable Amazon S3 media storage. - -S3_STATIC_ENABLED ------------------ - - | Default: ``False`` - | Env: ``S3_STATIC_ENABLED`` - - Enable/disable Amazon S3 static storage. - -SEARCH_FILTERS --------------- - - Default:: - - 'TEXT_ENABLED': True, - 'TYPE_ENABLED': True, - 'CATEGORIES_ENABLED': True, - 'OWNERS_ENABLED': True, - 'KEYWORDS_ENABLED': True, - 'H_KEYWORDS_ENABLED': True, - 'T_KEYWORDS_ENABLED': True, - 'DATE_ENABLED': True, - 'REGION_ENABLED': True, - 'EXTENT_ENABLED': True, - - Enabled Search Filters for filtering resources. - -SECURE_BROWSER_XSS_FILTER -------------------------- - - | Default: ``True`` - | Env: ``SECURE_BROWSER_XSS_FILTER`` - - If True, the SecurityMiddleware sets the X-XSS-Protection: 1; mode=block header on all responses that do not already have it. - This is ``__ - -SECURE_CONTENT_TYPE_NOSNIFF ---------------------------- - - | Default: ``True`` - | Env: ``SECURE_CONTENT_TYPE_NOSNIFF`` - - If True, the SecurityMiddleware sets the X-Content-Type-Options: nosniff header on all responses that do not already have it. - This is `Django settings: `__ - - -SECURE_HSTS_INCLUDE_SUBDOMAINS ------------------------------- - - | Default: ``True`` - | Env: ``SECURE_HSTS_INCLUDE_SUBDOMAINS`` - - This is Django settings: https://docs.djangoproject.com/en/2.1/ref/settings/#secure-hsts-include-subdomains - -SECURE_HSTS_SECONDS -------------------- - - | Default: ``3600`` - | Env: ``SECURE_HSTS_SECONDS`` - - This is `Django settings: `__ - If set to a non-zero integer value, the SecurityMiddleware sets the HTTP Strict Transport Security header on all responses that do not already have it. - -SECURE_SSL_REDIRECT -------------------- - - If True, the SecurityMiddleware redirects all non-HTTPS requests to HTTPS (except for those URLs matching a regular expression listed in SECURE_REDIRECT_EXEMPT). - This is `Django settings: `__ - -SERVICE_UPDATE_INTERVAL ------------------------ - - | Default: ``0`` - - The Interval services are updated. - -SESSION_COOKIE_SECURE ---------------------- - - | Default: ``False`` - | Env: ``SESSION_COOKIE_SECURE`` - - This is a `Django setting: `__ - -SESSION_EXPIRED_CONTROL_ENABLED -------------------------------- - - | Default: ``True`` - | Env: ``SESSION_EXPIRED_CONTROL_ENABLED`` - - By enabling this variable, a new middleware ``geonode.security.middleware.SessionControlMiddleware`` will be added to the ``MIDDLEWARE_CLASSES``. - The class will check every request to GeoNode and it will force a log out whenever one of the following conditions occurs: - - #. The OAuth2 Access Token is not valid anymore or it is expired. - - .. warning:: The Access Token might be invalid for various reasons. Usually a misconfiguration of the OAuth2 ``GeoServer`` application. - The latter is typically installed and configured automatically at GeoNode bootstrap through the default fixtures. - #. The user has been deactivated for some reason; an Admin has disabled it or its password has expired. - - Whenever the middleware terminates the session and the user forced to log out, a message will appear to the GeoNode interface. - -SHOW_PROFILE_EMAIL ------------------- - - Default: ``False`` - - A boolean which specifies whether to display the email in the user’s profile. - -SITE_HOST_NAME --------------- - - | Default: ``localhost`` - | Env: ``SITE_HOST_NAME`` - - The hostname used for GeoNode. - -SITE_HOST_PORT --------------- - - | Default: ``8000`` - | Env: ``SITE_HOST_PORT`` - - The Site hostport. - -SITEURL -------- - - Default: ``'http://localhost:8000/'`` - - A base URL for use in creating absolute links to Django views and generating links in metadata. - -SKIP_PERMS_FILTER ------------------ - - | Default: ``False`` - | Env: ``SKIP_PERMS_FILTER`` - - If set to true permissions prefiltering is avoided. - -SOCIALACCOUNT_ADAPTER ---------------------- - - Default: ``geonode.people.adapters.SocialAccountAdapter`` - - This is a `django-allauth setting `__ - It allows specifying a custom class to handle authentication for social accounts. - -SOCIALACCOUNT_AUTO_SIGNUP -------------------------- - - Default: ``True`` - - Attempt to bypass the signup form by using fields (e.g. username, email) retrieved from the social account provider. - This is a `Django-allauth setting: `__ - - -SOCIALACCOUNT_PROVIDERS ------------------------ - - Default:: - - { - 'linkedin_oauth2': { - 'SCOPE': [ - 'r_emailaddress', - 'r_basicprofile', - ], - 'PROFILE_FIELDS': [ - 'emailAddress', - 'firstName', - 'headline', - 'id', - 'industry', - 'lastName', - 'pictureUrl', - 'positions', - 'publicProfileUrl', - 'location', - 'specialties', - 'summary', - ] - }, - 'facebook': { - 'METHOD': 'oauth2', - 'SCOPE': [ - 'email', - 'public_profile', - ], - 'FIELDS': [ - 'id', - 'email', - 'name', - 'first_name', - 'last_name', - 'verified', - 'locale', - 'timezone', - 'link', - 'gender', - ] - }, - } - - This is a `django-allauth setting `__ - It should be a dictionary with provider specific settings - -SOCIALACCOUNT_PROFILE_EXTRACTORS --------------------------------- - - Default:: - - { - "facebook": "geonode.people.profileextractors.FacebookExtractor", - "linkedin_oauth2": "geonode.people.profileextractors.LinkedInExtractor", - } - - A dictionary with provider ids as keys and path to custom profile extractor - classes as values. - -SOCIAL_BUTTONS --------------- - - Default: ``True`` - - A boolean which specifies whether the social media icons and JavaScript should be rendered in GeoNode. - -SOCIAL_ORIGINS --------------- - - Default:: - - SOCIAL_ORIGINS = [{ - "label":"Email", - "url":"mailto:?subject={name}&body={url}", - "css_class":"email" - }, { - "label":"Facebook", - "url":"http://www.facebook.com/sharer.php?u={url}", - "css_class":"fb" - }, { - "label":"Twitter", - "url":"https://twitter.com/share?url={url}", - "css_class":"tw" - }, { - "label":"Google +", - "url":"https://plus.google.com/share?url={url}", - "css_class":"gp" - }] - - A list of dictionaries that are used to generate the social links displayed in the Share tab. For each origin, the name and URL format parameters are replaced by the actual values of the ResourceBase object (layer, map, document). - - -SRID ----- - - Default:: - - { - 'DETAIL': 'never', - } - -T -= - -TASTYPIE_DEFAULT_FORMATS ------------------------- - - Default: ``json`` - - This setting allows you to globally configure the list of allowed serialization formats for your entire site. - This is a `tastypie setting: `__ - -THEME_ACCOUNT_CONTACT_EMAIL ---------------------------- - - Default: ``'admin@example.com'`` - - This email address is added to the bottom of the password reset page in case users have trouble unlocking their account. - -THESAURI --------- - - Default = ``[]`` - - A list of Keywords thesauri settings: - For example `THESAURI = [{'name':'inspire_themes', 'required':True, 'filter':True}, {'name':'inspire_concepts', 'filter':True}, ]` - -TOPICCATEGORY_MANDATORY ------------------------ - - | Default: ``False`` - | Env: ``TOPICCATEGORY_MANDATORY`` - - If this option is enabled, Topic Categories will become strictly Mandatory on Metadata Wizard - -TWITTER_CARD ------------- - - Default:: ``True`` - - A boolean that specifies whether Twitter cards are enabled. - -TWITTER_SITE ------------- - - Default:: ``'@GeoNode'`` - - A string that specifies the site to for the twitter:site meta tag for Twitter Cards. - -TWITTER_HASHTAGS ----------------- - - Default:: ``['geonode']`` - - A list that specifies the hashtags to use when sharing a resource when clicking on a social link. - -U -= - -UNOCONV_ENABLE --------------- - - | Default: ``False`` - | Env: ``UNOCONV_ENABLE`` - -UPLOADER --------- - - Default:: - - { - 'BACKEND' : 'geonode.rest', - 'OPTIONS' : { - 'TIME_ENABLED': False, - } - } - - A dictionary of Uploader settings and their values. - - * BACKEND - - Default: ``'geonode.rest'`` - - The uploader backend to use. The backend choices are: - - ``'geonode.importer'`` - ``'geonode.rest'`` - - The importer backend requires the GeoServer importer extension to be enabled. - - * OPTIONS - - Default:: - - 'OPTIONS' : { - 'TIME_ENABLED': False, - } - - * TIME_ENABLED - - Default: ``False`` - - A boolean that specifies whether the upload should allow the user to enable time support when uploading data. - -USER_MESSAGES_ALLOW_MULTIPLE_RECIPIENTS ---------------------------------------- - - | Default: ``True`` - | Env: ``USER_MESSAGES_ALLOW_MULTIPLE_RECIPIENTS`` - - Set to true to have multiple recipients in /message/create/ - -.. _user-analytics: - -USER_ANALYTICS_ENABLED ----------------------- - - | Default: ``False`` - | Env: ``USER_ANALYTICS_ENABLED`` - - Set to true to anonymously collect user data for analytics. - If true you have to set :ref:`monitoring-data-aggregation` and :ref:`monitoring-skip-paths`. - - See :ref:`geonode_monitoring` to learn more about it. - -USER_ANALYTICS_GZIP -------------------- - - | Default: ``False`` - | Env: ``USER_ANALYTICS_GZIP`` - - To be used with ``USER_ANALYTICS_ENABLED``. - Compress ``gzip`` json messages before sending to ``logstash``. - -X -= - -X_FRAME_OPTIONS ---------------- - -Default: ``'ALLOW-FROM %s' % SITEURL`` - -This is a `Django setting `__ diff --git a/docs/basic/theme/img/bootswatch_theme.png b/docs/basic/theme/img/bootswatch_theme.png deleted file mode 100644 index b29b78abd8e..00000000000 Binary files a/docs/basic/theme/img/bootswatch_theme.png and /dev/null differ diff --git a/docs/basic/theme/img/css_override.png b/docs/basic/theme/img/css_override.png deleted file mode 100644 index e23ca5a092f..00000000000 Binary files a/docs/basic/theme/img/css_override.png and /dev/null differ diff --git a/docs/basic/theme/img/customized_geonode_project_home.png b/docs/basic/theme/img/customized_geonode_project_home.png deleted file mode 100644 index 8a1b884df78..00000000000 Binary files a/docs/basic/theme/img/customized_geonode_project_home.png and /dev/null differ diff --git a/docs/basic/theme/img/inspect_element.png b/docs/basic/theme/img/inspect_element.png deleted file mode 100644 index 19da276782e..00000000000 Binary files a/docs/basic/theme/img/inspect_element.png and /dev/null differ diff --git a/docs/basic/theme/img/logo_override.png b/docs/basic/theme/img/logo_override.png deleted file mode 100644 index bcc06119f06..00000000000 Binary files a/docs/basic/theme/img/logo_override.png and /dev/null differ diff --git a/docs/basic/theme/index.rst b/docs/basic/theme/index.rst deleted file mode 100644 index 0f5e8969ef4..00000000000 --- a/docs/basic/theme/index.rst +++ /dev/null @@ -1,315 +0,0 @@ -GeoNode Themes -============== - -| We have already explained in :ref:`simple-theming` how to change the GeoNode theme directly from the *Admin Interface*. - This is an easy way for customizing GeoNode appearance but, in some cases, you might want to have more control on it. -| In those cases, you have to venture into the code and it is highly recommended to use a GeoNode Project and customize it instead of the GeoNode default HTML/CSS code. - See the following sections to learn more about that. - -Theming your GeoNode Project -============================ - -There are a range of options available to you if you want to change the default look and feel of your :ref:`geonode-project`. -Since GeoNode’s style is based on `Bootstrap `_ you will be able to make use of all that Bootstrap has to offer in terms of theme customization. -You should consult Bootstrap’s documentation as your primary guide once you are familiar with how GeoNode implements Bootstrap and how you can override GeoNode’s theme and templates in your own project. - -Logos and graphics -^^^^^^^^^^^^^^^^^^ - -GeoNode intentionally does not include a large number of graphics files in its interface. -This keeps page loading time to a minimum and makes for a more responsive interface. -That said, you are free to customize your GeoNode’s interface by simply changing the default logo, or by adding your own images and graphics to deliver a GeoNode experience the way you envision it. - -Your GeoNode project has a directory already set up for storing your own images at ``/static/img``. -You should place any image files that you intend to use for your project in this directory. - -Let’s walk through an example of the steps necessary to change the default logo. - -#. Change to the :file:`img` directory: - - .. code-block:: console - - $ cd /static/img - -#. If you haven't already, obtain your logo image. The URL below is just an example, so you will need to change this URL to match the location of your file or copy it to this location: - - .. code-block:: console - - $ sudo wget https://upload.wikimedia.org/wikipedia/commons/thumb/a/ac/Service_mark.svg/500px-Service_mark.svg.png - $ sudo chown -Rf geonode: . - -#. Change to the :file:`css` directory: - - .. code-block:: console - - $ cd ../../.. - -#. Override the CSS that displays the logo by editing :file:`/static/css/site_base.css` with your favorite editor and adding the following lines, making sure to update the width, height, and URL to match the specifications of your image. - - .. code-block:: console - - $ sudo vi site_base.css - - .. code-block:: css - - .navbar-brand { - width: 350px; - height: 80px; - background: transparent url("../img/500px-Service_mark.svg.png") no-repeat; - background-size: 300px 70px; - background-position-y: center; - } - -#. Restart your GeoNode project and look at the page in your browser: - - .. code-block:: console - - $ cd /home/geonode - $ sudo rm -Rf geonode/geonode/static_root/* - $ cd my_geonode - $ python manage.py collectstatic - $ sudo service apache2 restart - - .. note:: It is a good practice to cleanup the **static_folder** and the Browser Cache before reloading in order to be sure that the changes have been correctly taken and displayed on the screen. - -Visit your site at http://localhost/ or the remote URL for your site. - -.. figure:: img/logo_override.png - :align: center - - *Custom logo* - -You can see that the header has been expanded to fit your graphic. -In the following sections you will learn how to customize this header to make it as you want. - -.. note:: You should commit these changes to your repository as you progress through this section, and get in the habit of committing early and often so that you and others can track your project on GitHub. - Making many atomic commits and staying in sync with a remote repository makes it easier to collaborate with others on your project. - -Cascading Style Sheets -^^^^^^^^^^^^^^^^^^^^^^ - -In the last section you already learned how to override GeoNode’s default CSS rules to include your own logo. -You are able to customize any aspect of GeoNode’s appearance this way. -In the last screenshot, you saw that the main area in the homepage is covered up by the expanded header. - -First, we’ll walk through the steps necessary to displace it downward so it is no longer hidden, then change the background color of the header to match the color in our logo graphic. - -#. Reopen :file:`/static/css/site_base.css` in your editor: - - .. code-block:: console - - $ cd /home/geonode/my_geonode/my_geonode/static/css - $ sudo vi site_base.css - -#. Add the following CSS rules to consider the expanded header height: - - .. code-block:: css - - #wrap { - margin-top: 100px !important; - padding-top: 0px; - } - -#. Add a rule to change the background color of the header to match the logo graphic: - - .. code-block:: css - - .navbar-inverse { - background-color: #ff0000 !important; - } - -#. Add a background image for the *hero* section: - - .. code-block:: css - - .jumbotron { - background: url("https://cdn.pixabay.com/photo/2017/09/16/16/09/sea-2755908_960_720.jpg") no-repeat !important; - background-size: cover !important; - } - -#. Your project CSS file should now look like this: - - .. code-block:: css - - .navbar-brand { - width: 350px; - height: 150px; - background: transparent url("../img/500px-Service_mark.svg.png") no-repeat; - background-size: 300px 100px; - background-position-y: center; - } - - #wrap { - margin-top: 100px !important; - padding-top: 0px; - } - - .navbar-inverse { - background-color: #ff0000 !important; - } - - .jumbotron { - background: url("https://cdn.pixabay.com/photo/2017/09/16/16/09/sea-2755908_960_720.jpg") no-repeat !important; - background-size: cover !important; - } - -#. Collect the static files into STATIC_ROOT, restart the development server and reload the page: - - .. code-block:: console - - $ python manage.py collectstatic - $ sudo service apache2 restart - -.. figure:: img/css_override.png - :align: center - - *CSS override* - -You can continue adding rules to this file to override the styles that are in the GeoNode base CSS file which is built from `base.less `_. - -.. note:: You may find it helpful to use your browser's development tools to inspect elements of your site that you want to override to determine which rules are already applied. See the screenshot below. - - .. figure:: img/inspect_element.png - :align: center - - *Screenshot of using browser debugger to inspect the CSS overrides* - -Templates and static pages -^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Now that we have changed the default logo and adjusted our main content area to fit the expanded header, the next step is to update the content of the homepage itself. -Your GeoNode project includes two basic templates that you will use to change the content of your pages. - -The file :file:`site_base.html` (in :file:`/templates/`) is the basic template that all other templates inherit from and you will use it to update things like the header, navbar, site-wide announcement, footer, and also to include your own JavaScript or other static content included in every page in your site. -It's worth taking a look at `GeoNode's base file on GitHub `_. -You have several blocks available to you for overriding, but since we will be revisiting this file in future sections of this guide, let's just look at it for now and leave it unmodified. - -Open :file:`/templates/site_base.html` in your editor: - -.. code-block:: console - - $ cd /home/geonode/my_geonode/my_geonode/templates - $ sudo vi site_base.html - -You will see that it extends from :file:`base.html`, which is the GeoNode template referenced above and it currently only overrides the ``extra_head`` block to include our project's :file:`site_base.css` which we have modified in the previous section. - -.. code-block:: html - - {% extends "base.html" %} - {% block extra_head %} - - {% endblock %} - -You can see on `line 189 of the GeoNode base.html template `_ that this block is included in an empty state and is set up specifically for you to include extra CSS files as your project is already set up to do. - -| The file :file:`site_index.html` is the template used to define your GeoNode project's homepage. - Let's actually override this template. -| It extends GeoNode's default :file:`index.html` template and gives you the option to override specific areas of the homepage like the *hero area*, but it also allows you leave other sections as they are. - You are of course free to override the sections which you prefer, the following steps give you an example. - -1. Open :file:`/templates/site_index.html` in your editor. - -2. Edit the first ``

    `` element inside the ``
    `` to say something other than "Welcome": - - .. code-block:: html - -

    {{custom_theme.jumbotron_welcome_title|default:_("GeoNode Project Example")}}

    - - .. warning:: Pay attention to the ``custom_theme.jumbotron_welcome_title`` part, if you delete it you will cannot use the "admin-based" theme customization option (see :ref:`simple-theming`) - -3. Edit the introductory paragraph to say something about your GeoNode project: - - .. code-block:: html - -

    -

    {{custom_theme.jumbotron_welcome_content|default:_("This GeoNode has been customized through my GeoNode Project.")}}

    -

    - - .. warning:: Take care of the ``custom_theme.jumbotron_welcome_content`` if you are using the "admin-based" theme customization option (see :ref:`simple-theming`) - -4. Your edited ``site_index.html`` file should now look like this: - - .. code-block:: html - - {% extends 'index.html' %} - {% load i18n %} - - {% comment %} - This is where you can override the hero area block. You can simply modify the content below or replace it wholesale to meet your own needs. - {% endcomment %} - - {% block hero %} -
    -
    -

    {{custom_theme.jumbotron_welcome_title|default:_("GeoNode Project Example")}}

    -

    -

    {{custom_theme.jumbotron_welcome_content|default:_("This GeoNode has been customized through my GeoNode Project.")}}

    - {% if not custom_theme.jumbotron_cta_hide %} -

    - - {{custom_theme.jumbotron_cta_text|default:_("Get Started »")}} - -

    - {% endif %} -
    -
    - {% endblock %} - -5. Collect the static files into STATIC_ROOT, restart the development server and reload the page to see the changes: - - .. code-block:: console - - $ python manage.py collectstatic - $ sudo service apache2 restart - - .. figure:: img/customized_geonode_project_home.png - :align: center - - *Customized Geonode Project Home Page* - -Other theming options -^^^^^^^^^^^^^^^^^^^^^ - -You are able to change any specific piece of your GeoNode project’s style by adding CSS rules to site_base.css, but since GeoNode is based on Bootstrap, there are many pre-defined themes that you can simply drop into your project to get a whole new look. -This is very similar to `WordPress `_ themes and it is a powerful and easy way to change the look of your site without much effort. - -Bootswatch -~~~~~~~~~~ - -From `Bootswatch `_ you can download ready-to-use themes for Bootstrap-based website. - -.. warning:: Currently GeoNode uses the 3.3.7 version of Bootstrap, so `suitable Bootswatch themes `_ should have been built for the same version. - -The following steps will show you how to use a theme from Bootswatch in your own GeoNode Project. - -1. Downoload the `Bootswatch themes for Bootstrap v3.3.7 archive `_ and extract it on some folder in your disk. - -2. Select a theme (in this example we will use *Sandstone*) and copy the ``bootstrap.css`` file inside the theme folder to the ``/static/css`` (the static folder of your GeoNode Project). - -3. Update the ``site_base.html`` template to include this file. It should now look like this: - - .. code-block:: console - - $ cd /templates - $ sudo vi site_base.html - - .. code-block:: html - - {% extends "base.html" %} - {% block extra_head %} - - - {% endblock %} - -5. Collect the static files into STATIC_ROOT, restart the development server and reload the page: - - .. code-block:: console - - $ python manage.py collectstatic - $ sudo service apache2 restart - - .. figure:: img/bootswatch_theme.png - :align: center - - *Bootswatch Theme for the Geonode Project* diff --git a/docs/build.sh b/docs/build.sh deleted file mode 100755 index e7540d9d9de..00000000000 --- a/docs/build.sh +++ /dev/null @@ -1 +0,0 @@ -sphinx-build -T -E -d _build/doctrees-readthedocs -D language=en . _build/html diff --git a/docs/conf.py b/docs/conf.py deleted file mode 100644 index e19b68b428c..00000000000 --- a/docs/conf.py +++ /dev/null @@ -1,270 +0,0 @@ -# -*- coding: utf-8 -*- -# -# GeoNode documentation build configuration file, created by -# sphinx-quickstart on Mon Oct 3 16:20:38 2011. -# -# This file is execfile()d with the current directory set to its containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. - -import sys, os - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -DOC_PATH = os.path.dirname(__file__) -PROJ_PATH = os.path.join(DOC_PATH, '../') -sys.path.extend([DOC_PATH, PROJ_PATH]) -os.environ.setdefault("DJANGO_SETTINGS_MODULE", "geonode.settings") - -# -- General configuration ----------------------------------------------------- - -# If your documentation needs a minimal Sphinx version, state it here. -#needs_sphinx = '1.0' - -# Add any Sphinx extension module names here, as strings. They can be extensions -# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo'] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -# The suffix of source filenames. -source_suffix = '.rst' - -# The encoding of source files. -#source_encoding = 'utf-8-sig' - -# The master toctree document. -master_doc = 'index' - -# General information about the project. -project = 'GeoNode' -copyright = '2017-2019, Open Source Geospatial Foundation, CC-SA' - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The short X.Y version. -version = '2.10' -# The full version, including alpha/beta/rc tags. -release = '2.10' - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -#language = None -language = 'en' - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -#today = '' -# Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -exclude_patterns = ['_build'] - -# The reST default role (used for this markup: `text`) to use for all documents. -#default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -#add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -#show_authors = False - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' - -# A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] - -locale_dirs = ['i18n/'] -gettext_compact = True - -# -- Options for HTML output --------------------------------------------------- - -on_rtd = os.environ.get('READTHEDOCS', None) == 'True' -if not on_rtd: - import sphinx_rtd_theme - html_theme = "sphinx_rtd_theme" - html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] - -#html_theme = "default" - - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -#html_theme_options = {} - -# Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] - -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -#html_title = None - -# A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -#html_logo = None - -# The name of an image file (within the static path) to use as favicon of the -# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -#html_favicon = None - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -# html_static_path = ['_static'] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -#html_last_updated_fmt = '%b %d, %Y' - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -#html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -#html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -#html_additional_pages = {} - -# If false, no module index is generated. -#html_domain_indices = True - -# If false, no index is generated. -#html_use_index = True - -# If true, the index is split into individual pages for each letter. -#html_split_index = False - -# If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True - -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -#html_show_sphinx = True - -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -#html_show_copyright = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -#html_use_opensearch = '' - -# This is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = None - -# Output file base name for HTML help builder. -htmlhelp_basename = 'GeoNodedoc' - -# -- Options for LaTeX output -------------------------------------------------- - -# The paper size ('letter' or 'a4'). -#latex_paper_size = 'letter' - -# The font size ('10pt', '11pt' or '12pt'). -#latex_font_size = '10pt' - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, author, documentclass [howto/manual]). -latex_documents = [ - ('index', 'GeoNode.tex', 'GeoNode Documentation', - 'GeoNode Development Team', 'manual'), -] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -#latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -#latex_use_parts = False - -# If true, show page references after internal links. -#latex_show_pagerefs = False - -# If true, show URL addresses after external links. -#latex_show_urls = False - -# Additional stuff for the LaTeX preamble. -#latex_preamble = '' - -# Documents to append as an appendix to all manuals. -#latex_appendices = [] - -# If false, no module index is generated. -#latex_domain_indices = True - - -# -- Options for manual page output -------------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [ - ('index', 'geonode', 'GeoNode Documentation', - ['GeoNode Development Team'], 1) -] - - -# -- Options for Epub output --------------------------------------------------- - -# Bibliographic Dublin Core info. -epub_title = 'GeoNode' -epub_author = 'GeoNode Development Team' -epub_publisher = 'GeoNode Development Team' -epub_copyright = '2017-2019, Open Source Geospatial Foundation, CC-SA' - -# The language of the text. It defaults to the language option -# or en if the language is not set. -#epub_language = '' - -# The scheme of the identifier. Typical schemes are ISBN or URL. -#epub_scheme = '' - -# The unique identifier of the text. This can be a ISBN number -# or the project homepage. -#epub_identifier = '' - -# A unique identification for the text. -#epub_uid = '' - -# HTML files that should be inserted before the pages created by sphinx. -# The format is a list of tuples containing the path and title. -#epub_pre_files = [] - -# HTML files shat should be inserted after the pages created by sphinx. -# The format is a list of tuples containing the path and title. -#epub_post_files = [] - -# A list of files that should not be packed into the epub file. -#epub_exclude_files = [] - -# The depth of the table of contents in toc.ncx. -#epub_tocdepth = 3 - -# Allow duplicate toc entries. -#epub_tocdup = True - -#def setup(app): - # from _ext import django_model_fields - # app.connect('autodoc-process-docstring', django_model_fields.process_docstring) diff --git a/docs/contribute/frontend-development/index.rst b/docs/contribute/frontend-development/index.rst deleted file mode 100644 index 4002258bea0..00000000000 --- a/docs/contribute/frontend-development/index.rst +++ /dev/null @@ -1,90 +0,0 @@ -Frontend development -==================== - - -Knowledge of handling node/npm is required. - -The GeoNode frontend dependencies can be found in ./geonode/static. To -manage dependencies, we recommend the use of yarn package manager (https://yarnpkg.com/lang/en). - - -First steps: ------------- - -``yarn install`` - -Installs the required libraries to ./node_modules - -``yarn install @version [--dev]`` - -Installs a package with a defined version. Using ``–dev`` installs a -dependency that is only available for the build process (see: package.json devDependencies). - -``yarn remove `` - -Removes a package. - -``yarn outdated`` - -Shows version information. - -``yarn why `` - -Get information on why this package was installed. - -**For further information on how to install or use please visit the official yarn documentation.** - -File/Folder overview: ---------------------- - -``./static_dependencies.json`` - -includes all dependencies associated with each -file. For example all files which should be minified to assets.min.js are named as values. -All files that should be copied to lib folder (for DEBUG_STATIC) are values of key `other_dependencies` and so on. Before you can use a dependency it has to be added to package.json by use of yarn. - -``./Gruntfile.js`` - -reads the dependencies from static_dependencies.json -and contains all workflows. - -geonode/static/geonode -~~~~~~~~~~~~~~~~~~~~~~ - -The ./geonode folder contains GeoNode’s stylesheets and javascript -files. The CSS files are generated via less. CSS files should therefore -never be changed directly but it’s corresponding less file. Further this folder -should never be deleted! - -geonode/static/lib -~~~~~~~~~~~~~~~~~~ - -The ./lib folder contains all the third-party files. -This folder can be deleted as it will be -fully generated by use of grunt ``development|production`` - - -Example 1 – Change styling: -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -1. In your settings set ``DEBU_STATIC=True``. This will load unminified assets in your template. -2. Start the development server with ``paver start``. -3. Use ``grunt watch`` to watch all less files for change. -4. Change styling in ./geonode/static/geonode/less -5. If our changes are as expected create a new build with - ``grunt development`` (files are not minimized) or - ``grunt production`` (files are minimized) - -Example 2 – add/update a new library: -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -1. In your settings set ``DEBU_STATIC=True``. This will load unminified assets in your template. -2. yarn add angular@1.7 -3. ``vim static_dependencies.json`` Edit the file and add your dependency to its fitting - destination. For example, assets.min.js -4. Check if some Django template (for example, base.html) includes the file and add it or adjust the version -5. use `grunt production` to build the package - -**For further tasks have a look at gruntfile.js or ask for help in the development mailing list** - -.. note:: Please make maintainers work easier and add a message to your commit why a library has been added. (For example, commit -m 'select2 added for permissions form on layer detail page') diff --git a/docs/contribute/index.rst b/docs/contribute/index.rst deleted file mode 100644 index 077f5edb0d8..00000000000 --- a/docs/contribute/index.rst +++ /dev/null @@ -1,27 +0,0 @@ -Participate in the Discussion -============================= - -Report Problems on the Issue Tracking System -============================================ - -Write Documentation -=================== - -Provide Translations -==================== - -.. toctree:: - :maxdepth: 3 - - translation/index - -Write Code -========== - -Frontend Development -==================== - -.. toctree:: - :maxdepth: 3 - - frontend-development/index diff --git a/docs/contribute/translation/img/github_commit.png b/docs/contribute/translation/img/github_commit.png deleted file mode 100644 index 92b3092d04d..00000000000 Binary files a/docs/contribute/translation/img/github_commit.png and /dev/null differ diff --git a/docs/contribute/translation/img/github_drag_files.png b/docs/contribute/translation/img/github_drag_files.png deleted file mode 100644 index f848f74f1d1..00000000000 Binary files a/docs/contribute/translation/img/github_drag_files.png and /dev/null differ diff --git a/docs/contribute/translation/img/github_upload.png b/docs/contribute/translation/img/github_upload.png deleted file mode 100644 index a801b01c2f5..00000000000 Binary files a/docs/contribute/translation/img/github_upload.png and /dev/null differ diff --git a/docs/contribute/translation/img/poedit_compile.png b/docs/contribute/translation/img/poedit_compile.png deleted file mode 100644 index db8a7fdbe45..00000000000 Binary files a/docs/contribute/translation/img/poedit_compile.png and /dev/null differ diff --git a/docs/contribute/translation/img/poedit_interface.png b/docs/contribute/translation/img/poedit_interface.png deleted file mode 100644 index 6725991e3c8..00000000000 Binary files a/docs/contribute/translation/img/poedit_interface.png and /dev/null differ diff --git a/docs/contribute/translation/img/poedit_needs_work.png b/docs/contribute/translation/img/poedit_needs_work.png deleted file mode 100644 index aa1a050513a..00000000000 Binary files a/docs/contribute/translation/img/poedit_needs_work.png and /dev/null differ diff --git a/docs/contribute/translation/img/poedit_sort.png b/docs/contribute/translation/img/poedit_sort.png deleted file mode 100644 index 87963bb5b31..00000000000 Binary files a/docs/contribute/translation/img/poedit_sort.png and /dev/null differ diff --git a/docs/contribute/translation/img/poedit_validate.png b/docs/contribute/translation/img/poedit_validate.png deleted file mode 100644 index 1c69060f43b..00000000000 Binary files a/docs/contribute/translation/img/poedit_validate.png and /dev/null differ diff --git a/docs/contribute/translation/img/poedit_warning.png b/docs/contribute/translation/img/poedit_warning.png deleted file mode 100644 index 8f14d45d95f..00000000000 Binary files a/docs/contribute/translation/img/poedit_warning.png and /dev/null differ diff --git a/docs/contribute/translation/index.rst b/docs/contribute/translation/index.rst deleted file mode 100644 index a82e6f111e2..00000000000 --- a/docs/contribute/translation/index.rst +++ /dev/null @@ -1,134 +0,0 @@ -Contribute to Translations -========================== - -Behind the scenes, GeoNode is using a software called GNU gettext further text-based translation files (django.po and djangojs.po) for translating content. If you'd like to know more about how all of this works you'll find a full description at the `Django Docs -`_. -Following will concentrate on what is needed for edit existing or contribute a new translation. - -Download the translation File -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -All language files live in a specific subfolder called after their `iso code `_ within the `locale folder `_. -For example, for French, the main translation file called django.po can be downloaded from `here `_. - -Next, to download the language file, we need to install an OpenSource Editor called "poedit" for editing from: https://poedit.net/download - -Translation process -^^^^^^^^^^^^^^^^^^^ -Make a copy of the file before starting the translation so that you can revert in case of errors. - -After installing 'poedit', you should be able to double click on the '.po' file to open it. Poedit’s interface should look similar to the one shown in the picture below: - -.. figure:: img/poedit_interface.png - :align: center - :width: 680px - :alt: Poedit interface - -Identifying translation issues -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -From the 'poedit' menu 'View', make sure that 'Entries with Errors first' is checked: - - -.. figure:: img/poedit_sort.png - :align: center - :width: 280px - :alt: Validate translation - -Next click on 'Validate Translations' from the 'Catalogue' menu: - -.. figure:: img/poedit_validate.png - :align: center - :width: 280px - :alt: Validate translation - -'Poedit' will place translations which may require additional consideration on top of the list. -A warning mark means that the interpretation might be not entirely consistent with the original phrase. This is not necessarily an error, just a warning asking the user to double check. - -.. figure:: img/poedit_warning.png - :align: center - :width: 680px - :alt: Poedit warning - -Following to marked phrases, 'Poedit' will show untranslated sentences. When clicking on one, it can be translated through the bottom panel. - -During translation pay special attention to the button saying 'needs work'. In case this button is checked, the phrase will be marked as 'fuzzy' and ignored in GeoNode. - -.. figure:: img/poedit_needs_work.png - :align: center - :alt: phrase needs work - -Saving translations -^^^^^^^^^^^^^^^^^^^ -As soon as the translation is complete, it must be saved and compiled. -Saving is straightforward. All you have to do is clicking the 'Save' button from the top menu. - -As a last step we compile the file. Compiling the translation means to create a binary ".mo" file out of the edited ".po" file. To do so, click on "Compile to MO" - -.. figure:: img/poedit_compile.png - :align: center - :width: 280px - :alt: save and compile - -Poedit will ask where to write the ".mo" file to, by default, this is the same folder as the edited '.po' resides in. The '.mo' file can be overwritten if necessary. - -Push translations to the repository -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -For sharing our updates, we must upload the files to GeoNode’s GitHub repository. -Go to the correct file position which, in case for French is: -https://github.com/GeoNode/geonode/tree/master/geonode/locale/fr/LC_MESSAGES - -Click on "Upload Files" - -.. figure:: img/github_upload.png - :align: center - :width: 680px - :alt: upload files - -Drag the updated files into the Upload form, and write a title/description of the changes - -.. figure:: img/github_drag_files.png - :align: center - :width: 680px - :alt: drag files - -Click on "Create a new branch for this commit…" and then click on the green button. - -.. figure:: img/github_commit.png - :align: center - :width: 680px - :alt: drag files - -The last step will create a `PULL REQUEST` which can be reviewed and then approved by a developer. - - -Activate updated translation at your server -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Once the files have been pushed to GitHub, it will be necessary to update your server to respect changed files. - -At this time, this can be done only by an administrator. From the server 'shell' following commands need to be executed: - -.. code-block:: shell - - workon geonode - cd /opt/geonode - DJANGO_SETTINGS_MODULE=geonode.settings python -W ignore manage.py collectstatic --noinput - sudo service uwsgi restart - - - -Texts not listed in .po files -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -In case you find a template output without corresponding translation you can add it as follows: - -Identify the corresponding template file which is responsible for outputting the text. Add a ``{% trans "TEXT" %}`` tag. Save the template file and run the following: - -.. code-block:: shell - - django-admin makemessages -l en -d django -e "html,txt,py" -i docs - django-admin makemessages -l en -d djangojs -e "js" -i docs -i node_modules -i lib - - -This will update the english .po file. also to update the language which should be edited by settings the ``-l fr`` parameter. Continue with updating the .po file as described above. diff --git a/docs/devel/docker/index.rst b/docs/devel/docker/index.rst deleted file mode 100644 index 19e00481c87..00000000000 --- a/docs/devel/docker/index.rst +++ /dev/null @@ -1,58 +0,0 @@ -Start to develop with Docker ----------------------------- - -How to run the instance for development -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Set the variable SET_DOCKER_ENV for development -............................................... - -.. code-block:: shell - - vi .env - -Change to - -.. code-block:: shell - - SET_DOCKER_ENV=development - -Use dedicated docker-compose files while developing -................................................... - -.. note:: In this example we are going to keep ``localhost`` as the target IP for GeoNode - -.. code-block:: shell - - docker-compose -f docker-compose.async.yml -f docker-compose.development.yml up - -How to debug -............ - -.. note:: We are supposing to use ``ipdb`` for debugging which is already available as package from the container - -Stop the container for the ``django`` service: - -.. code-block:: shell - - docker-compose stop django - -Run the container again with the option for *service ports*: - -.. code-block:: shell - - docker-compose run \ - -e DOCKER_ENV=development \ - -e IS_CELERY=False \ - -e DEBUG=True \ - -e GEONODE_LB_HOST_IP=localhost \ - -e GEONODE_LB_PORT=80 \ - -e SITEURL=http://localhost/ \ - -e ALLOWED_HOSTS="['localhost', ]" \ - -e GEOSERVER_PUBLIC_LOCATION=http://localhost/geoserver/ \ - -e GEOSERVER_WEB_UI_LOCATION=http://localhost/geoserver/ \ - --rm --service-ports django python manage.py runserver --settings=geonode.settings 0.0.0.0:8000 - -Access the site on http://localhost/ - -.. note:: If you set an ``ipdb`` debug point with import ``ipdb ; ipdb.set_trace()`` then you should be facing its console and you can see the django server which is restarting at any change of your code from your local machine. \ No newline at end of file diff --git a/docs/devel/index.rst b/docs/devel/index.rst deleted file mode 100644 index ad274d09d62..00000000000 --- a/docs/devel/index.rst +++ /dev/null @@ -1,26 +0,0 @@ -How to Develop -============== - -.. toctree:: - :maxdepth: 3 - - docker/index - -.. toctree:: - :maxdepth: 2 - - installation/index - -.. toctree:: - :maxdepth: 2 - - running/index - - -.. toctree:: - :maxdepth: 2 - - workshops/index - - -This documentation helps developers to install GeoNode-Core and GeoNode-Project from different scenarios. GeoNode-Project can be installed on top of GeoNode-Core if already installed. Also GeoNode-Project can be installed from scratch as it has GeoNode-Core as a prerequisit. \ No newline at end of file diff --git a/docs/devel/installation/img/geonode-gui.png b/docs/devel/installation/img/geonode-gui.png deleted file mode 100644 index 17108d3ef23..00000000000 Binary files a/docs/devel/installation/img/geonode-gui.png and /dev/null differ diff --git a/docs/devel/installation/img/server-is-ready.png b/docs/devel/installation/img/server-is-ready.png deleted file mode 100644 index b4270c89ecb..00000000000 Binary files a/docs/devel/installation/img/server-is-ready.png and /dev/null differ diff --git a/docs/devel/installation/index.rst b/docs/devel/installation/index.rst deleted file mode 100644 index f5245c7accb..00000000000 --- a/docs/devel/installation/index.rst +++ /dev/null @@ -1,406 +0,0 @@ -How to Install GeoNode-Core for development -=========================================== - -Summary of installation -....................... - -This section demonstrates a summarization of the steps to be followed in order to install GeoNode-Core for development using Ubuntu 18.04. The following steps will be customised to fit both GeoNode-Project and GeoNode-Core for development purpose. - -The steps to be followed are: -............................. - -1- Install build tools and libraries - -2- Install dependencies and supporting tools - -3- Setup Python virtual environment - -4- Clone and install GeoNode from Github - -5- Install and start Geoserver - -6- Start GeoNode - -.. note:: The following commands/steps will be executed on your terminal - -.. warning:: If you have a running GeoNode service, you will need to stop it before starting the following steps. To stop GeoNode you will need to run: - -.. code-block:: shell - - service apache2 stop # or your installed server - service tomcat7 stop # or your version of tomcat - -Install GeoNode-Core for development -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -GeoNode-Core installation is considered the most basic form of GeoNode. It doesn't require any external server to be installed and it can run locally against a file-system based SQLite database. - -Installation steps -.................. - -1- Install build tools and libraries - -.. code-block:: shell - - $ sudo apt-get install -y build-essential libxml2-dev libxslt1-dev libpq-dev zlib1g-dev - -2- Install dependencies and supporting tools - - Install python native libraries and tools - -.. code-block:: shell - - $ sudo apt-get install -y python3-dev python3-pil python3-lxml python3-pyproj python3-shapely python3-nose python3-httplib2 python3-pip software-properties-common - -Install python virtual environment - -.. code-block:: shell - - $ sudo pip install virtualenvwrapper - -Install postgresql and postgis - -.. code-block:: shell - - $ sudo apt-get install postgresql-10 postgresql-10-postgis-2.4 - -Change postgres password expiry and set a password - -.. code-block:: shell - - $ sudo passwd -u postgres # change password expiry infromation - $ sudo passwd postgres # change unix password for postgres - -Create geonode role and database - -.. code-block:: shell - - $ su postgres - $ createdb geonode_dev - $ createdb geonode_dev-imports - $ psql - $ postgres=# - $ postgres=# CREATE USER geonode_dev WITH PASSWORD 'geonode_dev'; # should be same as password in setting.py - $ postgres=# GRANT ALL PRIVILEGES ON DATABASE "geonode_dev" to geonode_dev; - $ postgres=# GRANT ALL PRIVILEGES ON DATABASE "geonode_dev-imports" to geonode_dev; - $ postgres=# \q - $ psql -d geonode_dev-imports -c 'CREATE EXTENSION postgis;' - $ psql -d geonode_dev-imports -c 'GRANT ALL ON geometry_columns TO PUBLIC;' - $ psql -d geonode_dev-imports -c 'GRANT ALL ON spatial_ref_sys TO PUBLIC;' - $ exit - -Edit PostgreSQL configuration file - -.. code-block:: shell - - sudo gedit /etc/postgresql/10/main/pg_hba.conf - -Scroll to the bottom of the file and edit this line - -.. code-block:: shell - - # "local" is for Unix domain socket connections only - local all all peer - -To be as follows - -.. code-block:: shell - - # "local" is for Unix domain socket connections only - local all all trust - -Then restart PostgreSQL to make the changes effective - -.. code-block:: shell - - sudo service postgresql restart - -Java dependencies - -.. code-block:: shell - - $ sudo apt-get install -y openjdk-11-jdk --no-install-recommends - -Install supporting tools - -.. code-block:: shell - - $ sudo apt-get install -y ant maven git gettext - -3- Setup Python virtual environment (Here is where Geonode will be running) - -Add the virtualenvwrapper to your new environment. - -Since we are using Ubuntu, you can add the following settings to your .bashrc file. Please note that the Ubuntu account here is called "geonode". So you will need to change it according to the name you picked. - -.. code-block:: shell - - $ echo export VIRTUALENVWRAPPER_PYTHON=/usr/bin/python >> ~/.bashrc - $ echo export WORKON_HOME=/home/geonode/dev/.venvs >> ~/.bashrc - $ echo source /usr/local/bin/virtualenvwrapper.sh >> ~/.bashrc - $ echo export PIP_DOWNLOAD_CACHE=$HOME/.pip-downloads >> ~/.bashrc - - And reload the settings by running - $ source ~/.bashrc - -Set up the local virtual environment for Geonode - -.. code-block:: shell - - $ vim ~/.bashrc - # add the following line to the bottom - $ source /usr/share/virtualenvwrapper/virtualenvwrapper.sh - -.. code-block:: shell - - $ source /usr/share/virtualenvwrapper/virtualenvwrapper.sh - $ mkvirtualenv --python=/usr/bin/python3 geonode - $ workon geonode - This creates a new directory where you want your project to be and creates a new virtualenvironment - -4- Download/Clone GeoNode from Github - -To download the latest geonode version from github, the command "git clone" is used - -.. Note:: If you are following the GeoNode training, skip the following command. You can find the cloned repository in /home/geonode/dev - -.. code-block:: shell - - $ git clone https://github.com/GeoNode/geonode.git - -Install Nodejs PPA and other tools required for static development - -This is required for static development - -.. Note:: If you are following GeoNode’s training, nodejs is already installed in the Virtual Machine skip the first three command and jump to cd geonode/geonode/static - -.. code-block:: shell - - $ sudo apt-get install nodejs npm - $ cd geonode/geonode/static - $ npm install --save-dev - -.. Note:: Every time you want to update the static files after making changes to the sources, go to geonode/static and run ‘grunt production’. - -.. warning:: Starting from the following step, you have to make sure that you installed GDAL correctly according to the documentation page "Install GDAL for Development" - -Install GeoNode in the new active local virtualenv - -.. code-block:: shell - - $ cd /home/geonode/dev # or to the directory containing your cloned GeoNode - $ pip install -e geonode - $ cd geonode/geonode - -Create local_settings.py - -Copy the sample file /home/geonode/dev/geonode/geonode/local_settings.py.geoserver.sample and rename it to be local_settings.py - -.. code-block:: shell - - $ cd /home/geonode/dev/geonode - $ cp geonode/local_settings.py.geoserver.sample geonode/local_settings.py - $ gedit geonode/local_settings.py - -In the local_settings.py file, add the following line after the import statements: - -.. code-block:: python - - SITEURL = "http://localhost:8000/" - -In the DATABASES dictionary under the 'default' key, change only the values for the keys NAME, USER and PASSWORD to be as follows: - -.. code-block:: python - - DATABASES = { - 'default': { - 'ENGINE': 'django.db.backends.postgresql_psycopg2', - 'NAME': 'geonode_dev', - 'USER': 'geonode_dev', - 'PASSWORD': 'geonode_dev', - ....... - ...... - ..... - .... - ... - }...} - -In the DATABASES dictionary under the 'datastore' key, change only the values for the keys NAME, USER and PASSWORD to be as follows: - -.. code-block:: python - - # vector datastore for uploads - 'datastore' : { - 'ENGINE': 'django.contrib.gis.db.backends.postgis', - #'ENGINE': '', # Empty ENGINE name disables - 'NAME': 'geonode_dev-imports', - 'USER' : 'geonode_dev', - 'PASSWORD' : 'geonode_dev', - ....... - ...... - ..... - .... - ... - } - - -In the CATALOGUE dictionary under the 'default' key, uncomment the USER and PASSWORD keys to activate the credentials for GeoNetwork as follows: - -.. code-block:: python - - CATALOGUE = { - 'default': { - # The underlying CSW implementation - # default is pycsw in local mode (tied directly to GeoNode Django DB) - 'ENGINE': 'geonode.catalogue.backends.pycsw_local', - # pycsw in non-local mode - # 'ENGINE': 'geonode.catalogue.backends.pycsw_http', - # GeoNetwork opensource - # 'ENGINE': 'geonode.catalogue.backends.geonetwork', - # deegree and others - # 'ENGINE': 'geonode.catalogue.backends.generic', - # The FULLY QUALIFIED base url to the CSW instance for this GeoNode - 'URL': urljoin(SITEURL, '/catalogue/csw'), - # 'URL': 'http://localhost:8080/geonetwork/srv/en/csw', - # 'URL': 'http://localhost:8080/deegree-csw-demo-3.0.4/services', - # login credentials (for GeoNetwork) - 'USER': 'admin', - 'PASSWORD': 'admin', - # 'ALTERNATES_ONLY': True, - }} - -5- Install and Start Geoserver - -From the virtual environment, first you need to align the database structure using the following command : - -.. code-block:: shell - - $ cd /home/geonode/dev/geonode - $ python manage.py migrate - -.. warning:: If the start fails because of an import error related to osgeo or libgeos, then please consult the `Install GDAL for Development `_ - - -then setup GeoServer using the following command: - -.. code-block:: shell - - $ paver setup - - $ paver sync - - -6- Now we can start our geonode instance - -.. warning:: Don’t forget to stop the GeoNode Production services if enabled - -.. code-block:: shell - - service apache2 stop - service tomcat7 stop - -.. code-block:: shell - - $ paver start - -The starting process will take around 20 seconds (depends on your machine) and at the end it shows the following message: - -.. image:: ./img/server-is-ready.png - -Now you can visit the geonode site by typing http://0.0.0.0:8000 into your browser window - -.. image:: ./img/geonode-gui.png - - - -Install GeoNode-Project for development after installing GeoNode-Core -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Geonode-Project gives the user flexibility to customize the installation of the GeoNode. Geonode itself will be installed as a requirement of your project. Inside the project structure it is possible to extend, replace or modify all geonode components (e.g. css and other static files, templates, models..) and even register new django apps without touching the original Geonode code. -In order to install GeoNode-Project, the following steps need to be executed alongside the previous GeoNode-Core installation steps. - - -1- Use django-admin.py to create a project "my_geonode" from a GeoNode-Project template as follows: - -.. note:: Before running the following command, make sure that you are currently working on the virtual environment and just outside geonode directory. The command will create a new project called "my_geonode" which should be located at the level of geonode-core installation directory "inside /home/geonode/dev" - -.. code-block:: shell - - $ django-admin.py startproject my_geonode --template=https://github.com/GeoNode/geonode-project/archive/master.zip -e py,rst,json,yml,ini,env,sample -n Dockerfile - - $ ls /home/geonode/dev # should output: geonode my_geonode - -.. note:: Although the following command might show that the majority of requirements are already satisfied "because GeoNode-Core was already installed", it is recommended to still execute it as it might update or install any missing package. - -2- Install all the required packages/tools for GeoNode-Project as follows: - -.. code-block:: shell - - $ pip install -e my_geonode - -.. note:: As mentioned earlier, GeoNode will be installed as requirement for the GeoNode-Project in order to be able to extend it - - -Install GeoNode-Project directly from scratch -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -If you didn't install GeoNode-Core earlier and you wanted to install GeoNode-Project directly, please follow these steps - -1- Create a virtual environment as follows: - -.. code-block:: shell - - $ vim ~/.bashrc - # add the following line to the bottom - $ source /usr/share/virtualenvwrapper/virtualenvwrapper.sh - -.. code-block:: shell - - $ source /usr/share/virtualenvwrapper/virtualenvwrapper.sh - $ mkvirtualenv --python=/usr/bin/python3 my_geonode - -2- Clone the geonode-project repo from Github - -.. code-block:: shell - - $ git clone https://github.com/GeoNode/geonode-project.git - - -3- Install Django framework as follows - -.. code-block:: shell - - $ pip install Django==2.2.9 - -4- Use django-admin.py to create a project "my_geonode" from a GeoNode-Project template as follows: - -.. code-block:: shell - - $ django-admin startproject --template=./geonode-project -e py,sh,md,rst,json,yml,ini,env,sample -n monitoring-cron -n Dockerfile my_geonode - -5- Install all the requirements for the GeoNode-Project and install the GeoNode-Project using pip - -.. code-block:: shell - - $ cd my_geonode - $ pip install -r requirements.txt --upgrade - $ pip install -e . --upgrade - -6- Install GDAL Utilities for Python - -.. code-block:: shell - - $ pip install pygdal=="`gdal-config --version`.*" # or refer to the link - -7- Install GeoServer and Tomcat using paver - -.. code-block:: shell - - $ paver setup - - $ paver sync - - $ paver start - -8- Visit http://localhost:8000/ - diff --git a/docs/devel/installation/install_gdal_for_development.rst b/docs/devel/installation/install_gdal_for_development.rst deleted file mode 100644 index 698f0fcb2f2..00000000000 --- a/docs/devel/installation/install_gdal_for_development.rst +++ /dev/null @@ -1,79 +0,0 @@ -How to Install GDAL for development -====================================== - -Summary of installation -....................... - -This section demonstrates a summarization of the steps to be followed in order to install GDAL 2.4.2 for development using python2.7 virtualenv with Ubuntu 18.04. The idea here is to install GDAL on the host machine and then refer to this installed version from the virtual environment to have identical versions. - -.. note:: The following commands/steps will be executed on your terminal - -.. warning:: The installation here is meant to serve GeoNode installation for development - -The steps to be followed are: -............................. - -1- Install GDAL on your host environment - -2- Validate your installation on the host machine - -3- From your python virtual environment, Run: pip install GDAL==$(gdal-config --version) --global-option=build_ext --global-option="-I/usr/include/gdal" - -4- Validate installation from host and virtual environment - - -Installation steps - -On a fresh Ubuntu 18.04 installation, we will be installing gdal version 2.4.2 - -1- Using the terminal in the host machine, run the following commands: - -.. code-block:: shell - - $ sudo add-apt-repository ppa:ubuntugis/ppa && sudo apt-get update - $ sudo apt-get install libgdal-dev python3-gdal - -.. note:: Make sure you don't have a newer version on the software list under /et/apt/sources.list.d/ - -2- Validate the installed version by running the following commands: - - -.. code-block:: shell - - $ sudo gdal-config --version #it should output 2.4.2 at this step - $ python -c "from osgeo import gdal; print gdal.__version__" #it should output 2.4.2 at this step - -3- Install GDAL on your virtual environment by referring to the same version which we just installed on the host machine. To do that, you will need to run the following command during activated virtual environment session as follows: - - - -.. code-block:: shell - - $ virtualenv -p python2.7 my_env # To create a python2.7 virtual environment called my_env - - $ # inside my_env/bin, run the following command to activate the virtual environment we just created - - $ source activate - - $ cd /home/geonode/my_env - - $ export CPLUS_INCLUDE_PATH=/usr/include/gdal - - $ export C_INCLUDE_PATH=/usr/include/gdal - - $ pip install GDAL==2.4.2 - -4- Confirm the installation - -In order to validate the installation between the host and the virtual environment, run the following command on both the host machine and on the activated virtual environment. If the results were identical, then GDAL for development is installed correctly for GeoNode - -.. code-block:: shell - - $ python -c "from osgeo import gdal; print gdal.__version__" # outputs "2.4.2" - -And from the activated environment: - -.. code-block:: shell - - $ (my_env) python -c "from osgeo import gdal; print gdal.__version__" # outputs "2.4.2" - diff --git a/docs/devel/running/index.rst b/docs/devel/running/index.rst deleted file mode 100644 index b07f7ce493a..00000000000 --- a/docs/devel/running/index.rst +++ /dev/null @@ -1,49 +0,0 @@ -How to run GeoNode Core for development -======================================= - - -In order to start Geonode Core for development, you need to make sure that no Geonode instance is running first. This can be done by running the following commands: - -.. code-block:: shell - - $ cd /home/user/geonode - - $ paver stop_geoserver - - $ paver stop_django - -Then you need to start both geoserver and django services as follows: - -.. code-block:: shell - - $ paver start_geoserver - - $ paver start_django - -Now you can visit your Geonode GUI by typing http://localhost:8000 into your browser window - - - -How to run GeoNode Project for development -=========================================== - - -In order to run a project for development, the following steps have to be followed: - -1- Make sure there is no running instance of Geonode first by running the following command: - -.. code-block:: shell - - $ cd /home/user/my_geonode - - $ paver stop - -The above command will stop all services related to Geonode if running - -2- Start the servers by running paver start as follows: - -.. code-block:: shell - - $ paver start - -Now you can visit your geonode project site by typing http://localhost:8000 into your browser window diff --git a/docs/devel/workshops/img/doi.png b/docs/devel/workshops/img/doi.png deleted file mode 100644 index a4e80c1067a..00000000000 Binary files a/docs/devel/workshops/img/doi.png and /dev/null differ diff --git a/docs/devel/workshops/img/explore-my-layers.png b/docs/devel/workshops/img/explore-my-layers.png deleted file mode 100644 index 5f72247c450..00000000000 Binary files a/docs/devel/workshops/img/explore-my-layers.png and /dev/null differ diff --git a/docs/devel/workshops/img/geocollection-menu.png b/docs/devel/workshops/img/geocollection-menu.png deleted file mode 100644 index aca8d9e59e0..00000000000 Binary files a/docs/devel/workshops/img/geocollection-menu.png and /dev/null differ diff --git a/docs/devel/workshops/img/geocollections-admin.png b/docs/devel/workshops/img/geocollections-admin.png deleted file mode 100644 index 9c05ecc6d51..00000000000 Binary files a/docs/devel/workshops/img/geocollections-admin.png and /dev/null differ diff --git a/docs/devel/workshops/img/geocollections-details.png b/docs/devel/workshops/img/geocollections-details.png deleted file mode 100644 index 0b94eee5579..00000000000 Binary files a/docs/devel/workshops/img/geocollections-details.png and /dev/null differ diff --git a/docs/devel/workshops/img/geonode-is-awesome.png b/docs/devel/workshops/img/geonode-is-awesome.png deleted file mode 100644 index 961b344014a..00000000000 Binary files a/docs/devel/workshops/img/geonode-is-awesome.png and /dev/null differ diff --git a/docs/devel/workshops/img/geonode-project-gui.png b/docs/devel/workshops/img/geonode-project-gui.png deleted file mode 100644 index 36e9c85f41d..00000000000 Binary files a/docs/devel/workshops/img/geonode-project-gui.png and /dev/null differ diff --git a/docs/devel/workshops/img/logged-in-geonode.png b/docs/devel/workshops/img/logged-in-geonode.png deleted file mode 100644 index d003c97f00d..00000000000 Binary files a/docs/devel/workshops/img/logged-in-geonode.png and /dev/null differ diff --git a/docs/devel/workshops/img/red-background.png b/docs/devel/workshops/img/red-background.png deleted file mode 100644 index 55c17d1de2f..00000000000 Binary files a/docs/devel/workshops/img/red-background.png and /dev/null differ diff --git a/docs/devel/workshops/img/view-permission.png b/docs/devel/workshops/img/view-permission.png deleted file mode 100644 index 662d357e2c2..00000000000 Binary files a/docs/devel/workshops/img/view-permission.png and /dev/null differ diff --git a/docs/devel/workshops/index.rst b/docs/devel/workshops/index.rst deleted file mode 100644 index 751718b7318..00000000000 --- a/docs/devel/workshops/index.rst +++ /dev/null @@ -1,948 +0,0 @@ -Workshops -============================================== - -The workshops documentation demonstrates few examples on how to utilize GeoNode-Project in order to extend/customize GeoNode's functionalities according to your business. The covered topics include the following: - -1- Customize your GeoNode with the geonode-project - -2- Customize the look and feel - -3- Create your ResourceBase Metadata - -4- Create your own django app - -5- Add a custom model - -6- Permissions and APIs - -7- Deploy your GeoNode - - -1- Customize your GeoNode with the geonode-project --------------------------------------------------- - -In this example, GeoNode-Project is cloned to create a template instance in which the rest of the examples will be building on top of it. - -1- Assuming you already installed GeoNode-Core, firstly we need to create a GeoNode-Project template and this can be achieved from the following command: - -.. code-block:: shell - - $ django-admin.py startproject my_geonode --template=https://github.com/GeoNode/geonode-project/archive/master.zip -e py,rst,json,yml,ini,env,sample -n Dockerfile - -Here, django-admin is used with startproject option to create my_geonode project copying the template which is passed as GeoNode-project Github repo. It also includes "py,rst,json,yml,ini,env,sample" extensions - -2- Once the cloning finished, the next step is to install the GeoNode-Project we just downloaded as follows: - -.. code-block:: shell - - $ pip install -e my_geonode - - -3- Install geoserver using paver as follows - -.. code-block:: shell - - $ cd /home/geonode/my_geonode - $ paver setup - -4- Note the GeoNode database connection parameters mentioned in the local_settings.py configuration file. If not found, copy local_settings.py.sample and rename it to local_settings.py then use psql to create the required user and grant the required privileges as follows: - -.. code-block:: shell - - $ su postgres - $ createdb geonode - $ psql - postgres=# CREATE USER geonode WITH PASSWORD 'geonode'; - CREATE ROLE - postgres=# GRANT ALL PRIVILEGES ON DATABASE "geonode" to geonode; - GRANT - postgres=# \q - -.. warning:: Don't forget to exit from postgres user before executing the following commands - -5- Run GeoNode using paver - -.. code-block:: shell - - $ cd /home/geonode/my_geonode - $ paver start - -.. note:: You may find this warning message: You have 132 unapplied migration(s). Your project may not work properly until you apply the migrations for app(s): account, actstream, admin, agon_ratings, announcements, auth, avatar, base, contenttypes, dialogos, documents, favorite, geonode_client, geonode_themes, groups, guardian, invitations, layers, maps, mapstore2_adapter, monitoring, oauth2_provider, people, pinax_notifications, services, sessions, sites, socialaccount, taggit, tastypie, upload, user_messages. Run 'python manage.py migrate' to apply them. - - -Which means you have some sql statements not executed yet and you need to run the "migrate" to sync your database first then "paver start" again as follows: - -.. code-block:: shell - - $ python manage.py migrate - $ paver start - -.. warning:: If encountered this message: ``(Invalid HTTP_HOST header: '0.0.0.0:8000'. You may need to add u'0.0.0.0' to ALLOWED_HOSTS)`` It can be fixed in the settings.py file. You will need to add: ``ALLOWED_HOSTS = ['0.0.0.0']`` in settings.py - -.. image:: ./img/geonode-project-gui.png - -6- Once the previous step is done, you can visit 0.0.0.0:8000 to view the GUI of GeoNode. However, we still don't have an account in order to login from the GUI. This can be done using "paver sync". The command will create sync with latest fixtures and also creates a superuser "admin" with default password "admin" - - -7- Use the created account to login from the GUI through localhost:8000 or 0.0.0.0:8000 - -.. image:: ./img/logged-in-geonode.png - - -2- Customize the look and feel ------------------------------- - -In this section we will change the look and feel of GeoNode, in particular we will do some customization to help understanding how the template inheritance works and how to add new stuff to your GeoNode. The changes will include the home page, the top menu, the footer and a generic GeoNode page. - -**Homepage:** - -The geonode-project provides some predefined templates to change the home page and the general site content. - -In the "my_geonode/my_geonode/templates" directory we can edit the site_index.html. - -Try to edit the content of the "jumbotron" box in the page, save and refresh your browser to see the changes. - -.. image:: ./img/geonode-is-awesome.png - -**The theme:** - -To change the theme of our geonode-project we can act on the site_base.css file available in the "my_geonode/my_geonode/static/css" folder. - -The file is empty so we can inspect elements of the home page with the browser's developer tools and define css rules in there. - -For example, if we want to change the background of the jumbotron, in this file we can add - -.. code:: css - - .home .jumbotron { background: red } - -Then once we refreshed the browser, we should see the change as follows: - -.. image:: ./img/red-background.png - - -Adding the ``".home"`` class is necessary in order to let the rule have precedence/priority over the GeoNode's one. We can see this by inspecting the element in the developer console. - -**The top menu:** - -Now we can make some changes that will apply to the whole site. We can add a Geocollections entry in the top menu bar. - -Edit the site_base.html file in the templates folder and uncomment the list item adapting the text as well from: - - -.. code-block:: python - - {% comment %} - Add Tab for Third Party Apps -
  • - App -
    • - {% endcomment %} -To: - -.. code-block:: python - -
  • - Geocollections -
    • - -On browser refresh you will see a new entry in the nav bar which is persistent to the whole site. - -.. image:: ./img/geocollection-menu.png - -**GeoNode generic page** - -As you can see in the templates folder there are only the site_index.html and the site_base.html files. In order to customize another GeoNode page, for example the layers list page, you need to recreate the same folder structure of the GeoNode templates folder and add a file with the same name. - -For the layers list page we can create a directory named "layers" inside the template directory and a file named "layer_list.html" inside layers. The changes made in this file will only affect the layer list page. - -.. code-block:: shell - - mkdir -p my_geonode/templates/layers/ - - cp geonode/geonode/layers/templates/layers/layer_list.html my_geonode/templates/layers/layer_list.html - - vim my_geonode/templates/layers/layer_list.html - -For example change in page title to be: - -.. code:: html - -

    {% trans "Explore My Layers" %}

    - -then refresh the browser to see the update. - -.. image:: ./img/explore-my-layers.png - -**Modify functionality** - - -In this section, we will patch the ResourceBase of GeoNode and update the Templates in order to add one more field to the Metadata Schema. - -We will add a DOI field to the ResourceBase model and modify the Templates in order to show the new field both into the Metadata Wizard and the Layer Details page. - -.. Note:: Make sure to be inside "my_geonode" directory to execute the following commands - - -Customizing metadata can be achieved from the model which is defined in the core at "geonode/geonode/base/models.py" as follows: - - -.. code-block:: python - - # internal fields - uuid = models.CharField(max_length=36) - owner = models.ForeignKey( - settings.AUTH_USER_MODEL, - blank=True, - null=True, - related_name='owned_resource', - verbose_name=_("Owner")) - contacts = models.ManyToManyField( - settings.AUTH_USER_MODEL, - through='ContactRole') - title = models.CharField(_('title'), max_length=255, help_text=_( - 'name by which the cited resource is known')) - alternate = models.CharField(max_length=128, null=True, blank=True) - date = models.DateTimeField( - _('date'), - default=now, - help_text=date_help_text) - date_type = models.CharField( - _('date type'), - max_length=255, - choices=VALID_DATE_TYPES, - default='publication', - help_text=date_type_help_text) - edition = models.CharField( - _('edition'), - max_length=255, - blank=True, - null=True, - help_text=edition_help_text) - abstract = models.TextField( - _('abstract'), - max_length=2000, - blank=True, - help_text=abstract_help_text) - purpose = models.TextField( - _('purpose'), - max_length=500, - null=True, - blank=True, - help_text=purpose_help_text) - maintenance_frequency = models.CharField( - _('maintenance frequency'), - max_length=255, - choices=UPDATE_FREQUENCIES, - blank=True, - null=True, - help_text=maintenance_frequency_help_text) - - -To add fields directly to the ResourceBase Class without actually modifying it, this can be done from "my_geonode/my_geonode/apps.py" file - -The "ready" method is invoked at initialization time and can be currently used to tweak your app in several ways - -.. code-block:: python - - - class AppConfig(BaseAppConfig): - - name = "my_geonode" - label = "my_geonode" - - def ready(self): - super(AppConfig, self).ready() - run_setup_hooks() - - -Now we will add the "patch_resource_base" method to the AppConfig and execute it from the ready method as follows: - -.. code-block:: python - - from django.db import models - from django.utils.translation import ugettext_lazy as _ - - - class AppConfig(BaseAppConfig): - - name = "my_geonode" - label = "my_geonode" - - def _get_logger(self): - import logging - return logging.getLogger(self.__class__.__module__) - - def patch_resource_base(self, cls): - self._get_logger().info("Patching Resource Base") - doi_help_text = _('a DOI will be added by Admin before publication.') - doi = models.TextField( - _('DOI'), - blank=True, - null=True, - help_text=doi_help_text) - cls.add_to_class('doi', doi) - - def ready(self): - super(AppConfig, self).ready() - run_setup_hooks() - - from geonode.base.models import ResourceBase - self.patch_resource_base(ResourceBase) - -.. note:: you will need to perform migrations as follows: - Add field doi to resourcebase - - -Once you run python manage.py migrate: - -.. code-block:: shell - - Running migrations: - Applying announcements.0002_auto_20200119_1257... OK - Applying base.0031_resourcebase_doi... OK - Applying people.0027_auto_20200119_1257... OK - - -Till now, we have patched the DB. however, it is not yet sufficient as we still need to display the added field. - -Let's extend the default templates so that we can show the newly added field - -**Overriding the Metadata Wizard Template Page** - -Similar to what we have done before in the Templates directory, we will need to create "layouts" directory under "my_geonode/my_geonode/templates". This directory will contain a copy from "geonode/src/geonode/geonode/layers/templates/layouts/panels.html" as follows: - -.. code-block:: shell - - $ mkdir -p my_geonode/templates/layouts - $ cp ~/geonode/src/geonode/geonode/layers/templates/layouts/panels.html my_geonode/templates/layouts/panels.html - $ vim my_geonode/templates/layouts/panels.html - -Inside panels.html, we will add a new div with text input as follows: - -.. code-block:: python - - {{ layer_form.data_quality_statement }} -
    -
    - - -
    - - -In addition, we will override the Layer Detail template page as follows: - -.. code-block:: shell - - mkdir -p my_geonode/templates/base - - cp /home/geo/Envs/geonode/src/geonode/geonode/base/templates/base/_resourcebase_info_panel.html my_geonode/templates/base/ - - vim my_geonode/templates/base/_resourcebase_info_panel.html - -.. code:: python - - -
    {{ group }}
    - -
    DOI
    -
    {{ resource.doi }}
    - - - -Now from the layer details page, you can see the DOI metadata entry per layer - -.. image:: ./img/doi.png - - -3- Create your own django app ------------------------------ - -In this section, we will demonstrate how to create and setup the skeleton of a custom app using the django facilities. The app will add a geocollections functionality to our GeoNode. - -The Gecollections app allows to present in a single page, resources and users grouped by a GeoNode Group. We can assign arbitrary resources to a Geocollection, a Group and a name that will be also used to build a dedicated URL. - -.. Note:: Make sure to be inside "my_geonode" directory to execute the following commands - -Create the django app - -Django gives us an handy command to create apps. We already used startproject to create our geonode-project, now we can use startapp to create the app. - -python manage.py startapp geocollections - -This will create a folder named geocollections that contains empty models and views. - -We need to add the new app to the INSTALLED_APPS of our project. inside "my_geonode/settings.py" line 54 change: - -.. code:: python - - INSTALLED_APPS += (PROJECT_NAME,) to be: INSTALLED_APPS += (PROJECT_NAME, 'geocollections',) - - -**Add a custom model** - -In this section, we will add a custom model and the related logic as follows: - -- Add a new model -- Add urls and views -- Add admin panel -- Add the template - -.. code-block:: shell - - vim geocollections/models.py - -.. code-block:: - - from django.db import models - - from geonode.base.models import ResourceBase - from geonode.groups.models import GroupProfile - - - class Geocollection(models.Model): - """ - A collection is a set of resources linked to a GeoNode group - """ - group = models.ForeignKey(GroupProfile, related_name='group_collections') - resources = models.ManyToManyField(ResourceBase, related_name='resource_collections') - name = models.CharField(max_length=128, unique=True) - slug = models.SlugField(max_length=128, unique=True) - - def __unicode__(self): - return self.name - - -At this point we need to ask django to create the database table. Django since version 1.8 has embedded migrations mechanism and we need to use them in order to change the state of the db. - -.. Note:: Make sure to be inside "my_geonode" directory to execute the following commands - -.. code-block:: shell - - python manage.py makemigrations - - # the above command informs you with the migrations to be executed on the database - - python manage.py migrate - -Next we will use django generic view to show the collections detail. Add the following code in the views.py file: - - -.. code-block:: shell - - vim geocollections/views.py - -.. code-block:: python - - from django.views.generic import DetailView - - from .models import Geocollection - - class GeocollectionDetail(DetailView): - model = Geocollection - - -Add url configuration - -In order to access the created view we also need url mapping. We can create a urls.py file containing a url mapping to our generic view: - - -.. code-block:: shell - - vim geocollections/urls.py - -.. code-block:: python - - from django.conf.urls import url - - from .views import GeocollectionDetail - - urlpatterns = [ - url(r'^(?P[-\w]+)/$', - GeocollectionDetail.as_view(), - name='geocollection-detail'), - ] - -We also need to register the app urls in the project urls. So let's modify the "my_geonode" urls.py file adding the following: - -.. code-block:: shell - - vim my_geonode/urls.py - -.. code-block:: python - - ... - urlpatterns += [ - ## include your urls here - url(r'^geocollections/', include('geocollections.urls')), - ] - ... - - -**Enable the admin panel** - -We need a user interface where we can create geocollections. Django makes this very easy, we just need the admin.py file as follows: - -.. code-block:: shell - - vim geocollections/admin.py - -.. code-block:: python - - from django.contrib import admin - - from .models import Geocollection - - - class GeocollectionAdmin(admin.ModelAdmin): - prepopulated_fields = {"slug": ("name",)} - filter_horizontal = ('resources',) - - admin.site.register(Geocollection, GeocollectionAdmin) - -Now we can visit the admin page and create a geocollection from there as follows: - -.. image:: ./img/geocollections-admin.png - -**Adding the template** - -Now we need the template where the geocollection detail will be rendered. Let's create a geocollections directory inside the "my_geonode/templates" directory with a file named geocollection_detail.html: - - -.. code-block:: shell - - mkdir -p my_geonode/templates/geocollections/ - - vim my_geonode/templates/geocollections/geocollection_detail.html - -.. code-block:: python - - {% extends "geonode_base.html" %} - {% block body %} -

    Geocollection {{ object.name }}

    -

    Group: {{ object.group.title }}

    -

    Resources:

    -
      - {% for resource in object.resources.all %} -
    • {{ resource.title }}
      • - {% endfor %} -
    - {% endblock %} - -To check the results, create a group in the geonode ui interface and load one or more layers/documents - -login into the admin panel -> geocollections and create a geocollections - -Visit http://localhost:8000/geocollections/ and view the results. - -.. image:: ./img/geocollections-details.png - - -Now you know how to customize an html template so you can tune this page as you prefer. - - - -**Permissions and APIs** - -In this section we will add some more advanced logic like permissions and APIs. The permissions in GeoNode are managed with django-guardian, a library which allow to set object level permissions (django has table level authorization). - -The APIs are implemented through django-tastypie. - -The topics to be covered include: - -- Permissions on who can view the geocollection -- How to add templated and js to embed a permission ui in our geocollection detail page -- API to serve json serialized searchable endpoint - - -Permissions logic (permissions objects) - -We need to add the permissions object to the database. We can do this by adding the following meta class to our Geocollection model, guardian will take care of creating the objects for us. - -.. code-block:: shell - - vim geocollections/models.py - -.. code-block:: python - - class Meta: - permissions = ( - ('view_geocollection', 'Can view geocollection'), - ) - -Then run "python manage.py makemigrations" and "python manage.py migrate" to install them - -**Permissions logic (set_default)** - -Let's add a method that will be used to set the default permissions on the Geocollections. We can add this logic to the Geocollection model but could also be a generic Mixin similar to how it is implemented in GeoNode. - - -.. code-block:: shell - - vim geocollections/models.py - -.. code-block:: python - - - from django.contrib.auth.models import Group - from django.contrib.auth import get_user_model - from django.contrib.contenttypes.models import ContentType - from django.conf import settings - from guardian.shortcuts import assign_perm - - def set_default_permissions(self): - """ - Set default permissions. - """ - - self.remove_object_permissions() - - # default permissions for anonymous users - anonymous_group, created = Group.objects.get_or_create(name='anonymous') - - if settings.DEFAULT_ANONYMOUS_VIEW_PERMISSION: - assign_perm('view_geocollection', anonymous_group, self) - - # default permissions for group members - assign_perm('view_geocollection', self.group, self) - -**Permissions logic (methods)** - -Now we need a method to add generic permissions, we want to be able to assign view permissions to groups and single users. We can add this to our Geocollection model - - -.. code-block:: shell - - vim geocollections/models.py - -.. code-block:: python - - def set_permissions(self, perm_spec): - anonymous_group = Group.objects.get(name='anonymous') - self.remove_object_permissions() - if 'users' in perm_spec and "AnonymousUser" in perm_spec['users']: - assign_perm('view_geocollection', anonymous_group, self) - if 'users' in perm_spec: - for user, perms in perm_spec['users'].items(): - user = get_user_model().objects.get(username=user) - assign_perm('view_geocollection', user, self) - if 'groups' in perm_spec: - for group, perms in perm_spec['groups'].items(): - group = Group.objects.get(name=group) - assign_perm('view_geocollection', group, self) - def remove_object_permissions(self): - from guardian.models import UserObjectPermission, GroupObjectPermission - UserObjectPermission.objects.filter(content_type=ContentType.objects.get_for_model(self), - object_pk=self.id).delete() - GroupObjectPermission.objects.filter(content_type=ContentType.objects.get_for_model(self), - object_pk=self.id).delete() - -Permissions logic (views.py) - -We can add now a view to receive and set our permissions, in views.py: - -.. code-block:: shell - - vim geocollections/views.py - -.. code-block:: python - - import json - from django.core.exceptions import PermissionDenied - from django.http import HttpResponse - from django.contrib.auth import get_user_model - - - User = get_user_model() - - def geocollection_permissions(request, collection_id): - - collection = Geocollection.objects.get(id=collection_id) - user = User.objects.get(id=request.user.id) - - if user.has_perm('view_geocollection', collection): - return HttpResponse( - 'You have the permission to view. please customize a template for this view'', - content_type='text/plain') - - if request.method == 'POST': - success = True - message = "Permissions successfully updated!" - try: - permission_spec = json.loads(request.body) - collection.set_permissions(permission_spec) - - return HttpResponse( - json.dumps({'success': success, 'message': message}), - status=200, - content_type='text/plain' - ) - except: - success = False - message = "Error updating permissions :(" - return HttpResponse( - json.dumps({'success': success, 'message': message}), - status=500, - content_type='text/plain' - ) - -**Permissions logic (url)** - -Lastly we need a url to map our client to our view, in urls.py - -.. code-block:: shell - - vim geocollections/urls.py - -.. code-block:: python - - from django.conf.urls import url - - from .views import GeocollectionDetail, geocollection_permissions - - urlpatterns = [ - url(r'^(?P[-\w]+)/$', - GeocollectionDetail.as_view(), - name='geocollection-detail'), - - url(r'^permissions/(?P\d+)$', - geocollection_permissions, - name='geocollection_permissions'), - ] - -This url will be called with the id of the geocollection, the id will be passed to the view in order to get the permissions. - -.. image:: ./img/view-permission.png - -.. warning:: - - A note on the client part, the server side logic is just one part necessary to implement permissions. - - A checklist of what is necessary: - - - A template snippet that can be embedded in the geocollection_detail.html, you can copy and simplify: _permissions_form.html and _permissions.html (in geonode/templates) - - - A javascript file that will collect permissions settings and send them to the server, you can copy and simplify: _permissions_form_js.html (in geonode/templates) - -**API** - -The GeoNode API system easily allows to plug in new APIs. This section demonstrates the required steps: - -We need first to create an api.py file in our geocollection app. - -.. code-block:: shell - - vim geocollections/api.py - -.. code-block:: python - - import json - from tastypie.resources import ModelResource - from tastypie import fields - from tastypie.constants import ALL_WITH_RELATIONS, ALL - - from geonode.api.api import ProfileResource, GroupResource - from geonode.api.resourcebase_api import ResourceBaseResource - - from .models import Geocollection - class GeocollectionResource(ModelResource): - - users = fields.ToManyField(ProfileResource, attribute=lambda bundle: bundle.obj.group.group.user_set.all(), full=True) - group = fields.ToOneField(GroupResource, 'group', full=True) - resources = fields.ToManyField(ResourceBaseResource, 'resources', full=True) - - class Meta: - queryset = Geocollection.objects.all().order_by('-group') - ordering = ['group'] - allowed_methods = ['get'] - resource_name = 'geocollections' - filtering = { - 'group': ALL_WITH_RELATIONS, - 'id': ALL - } - -**API authorization** - -We want the API to respect our custom permissions, we can easily achieve this by adding the following to the beginning of api.py: - -.. code-block:: shell - - vim geocollections/api.py - -.. code-block:: python - - from tastypie.authorization import DjangoAuthorization - from guardian.shortcuts import get_objects_for_user - - class GeocollectionAuth(DjangoAuthorization): - - def read_list(self, object_list, bundle): - permitted_ids = get_objects_for_user( - bundle.request.user, - 'geocollections.view_geocollection').values('id') - - return object_list.filter(id__in=permitted_ids) - - def read_detail(self, object_list, bundle): - return bundle.request.user.has_perm( - 'view_geocollection', - bundle.obj) - -And this to the GeocollectionResource Meta class: - -.. code-block:: python - - authorization = GeocollectionAuth() - -**Add a url for our API** - -In order to publish our API we need a url and we want that url to appear under the GeoNode's /api domain. - -The final url for our API has to be /api/geocollections. - -We can inject the url into the GeoNode API by adding the following lines to "my_geonode/urls.py" file: - -.. code-block:: shell - - vim my_geonode/urls.py - -.. code-block:: python - - from geonode.api.urls import api - - from geocollections.api import GeocollectionResource - - api.register(GeocollectionResource()) - -And add the following in the urlpatterns: - -.. code-block:: python - - url(r'', include(api.urls)), - -The final result will be: - -.. code-block:: python - - from django.conf.urls import url, include - from django.views.generic import TemplateView - - from geonode.urls import urlpatterns - - from geonode.api.urls import api - from geocollections.api import GeocollectionResource - - api.register(GeocollectionResource()) - - urlpatterns += [ - ## include your urls here - url(r'', include(api.urls)), - url(r'^geocollections/', include('geocollections.urls')), - ] - -Let's test permissions on API - -We can test the permissions on API by manually set a permission from the command line and check that the API respects it. - -With running ``python manage.py shell`` from inside our "my_geonode" folder, it opens a geonode shell. - -A perm spec could look like this: - -.. code:: python - - perms = { - 'users': { - 'AnonymousUser': ['view_geocollection'], - 'alessio': ['view_geocollection']} - } - -and we can assign the permissions with: - -.. code-block:: python - - from geocollections.models import Geocollection - - Geocollection.objects.first().set_permissions(perms) - -our http://localhost:8000/api/geocollections should now list the geocollection. - -If you remove the 'AnonymousUser' line from perms and assign again the permissions it will disappear. - -.. code:: python - - perms = { - 'users': { - 'alessio': ['view_geocollection'] - } - -**Deploy your GeoNode** - - -So far we demonstrated how to modify, extend and style our GeoNode in dev mode but now it's time to go on production. In this section we will clarify how to: - -- commit your work on GitHub - -- setup your server - -- setup your GeoNode for production - - - -Push to GitHub -It is always a good practice to keep your code in a remote repository, GithHub is one of the options and is indeed the most used. - -It is assumed that you already have a GitHub account and that you have git installed and configured with your name and email. - -We will push only the my_geonode folder to GitHub and as we knew earlier, GeoNode for us is a dependency and we'll just reinstall it as it is on the server. - -Steps to push your code to GitHub: - -- Create an empty repository in GitHub and copy it's address - -- In my_geonode, run git init to initialize an empty repository - -- Add your remote repository address with ``git remote add yourname yourremoteaddress`` - -- edit .gitignore adding all *.pyc files - -- ``git add *`` to add all content of my_geonode - -- ``git commit -m 'initial import'`` to make the initial commit - -- ``git push yourname master`` to push the code to the GitHub repository - - -**Setup the server** - -There are several options for deploying GeoNode projects on servers. In this section, we explain how to deploy it on Ubuntu server 18.04 using system-wide installation - -.. note:: For quick installation, follow the INSTALLING documentation at http://docs.geonode.org/en/master/install/core/index.html - - -**Setup our my_geonode** - -We need now to install the developed "my_geonode" project following these steps: - -- git clone from your repository (in the folder of your preference) - -- ``sudo pip install -e my_geonode`` - -- edit the settings where needed - -- edit ``/etc/apache2/sites-enabled/geonode.conf`` replacing the wsgi path to the ``my_geonode/my_geonode/wsgi.py`` file - -- add the apache rights to the "my_geonode" folder with a directory like - -.. code:: apache - - - Order allow,deny - Require all granted - - -- Test your server. diff --git a/docs/index.rst b/docs/index.rst deleted file mode 100644 index db55368646a..00000000000 --- a/docs/index.rst +++ /dev/null @@ -1,72 +0,0 @@ -.. _mainindex: - -======================= -GeoNode's Documentation -======================= - -Welcome to GeoNode's Documentation. - -GeoNode is an Open Source, Content Management System (CMS) for geospatial data. It is a web-based application and platform for developing geospatial information systems (GIS) and for deploying spatial data infrastructures (SDI). - -Table of contents -================= - -.. toctree:: - :caption: About - :maxdepth: 3 - - about/index - -.. toctree:: - :caption: Getting Started - :maxdepth: 3 - - start/index - -.. toctree:: - :caption: Using - :maxdepth: 3 - - usage/index - -.. toctree:: - :caption: Installing - :maxdepth: 3 - - install/index - -.. toctree:: - :caption: Configuring (Basic) - :maxdepth: 3 - - basic/index - -.. toctree:: - :caption: Configuring (Intermediate) - :maxdepth: 3 - - intermediate/index - -.. toctree:: - :caption: Configuring (Advanced) - :maxdepth: 3 - - advanced/index - -.. toctree:: - :caption: Administering - :maxdepth: 3 - - admin/index - -.. toctree:: - :caption: Contributing - :maxdepth: 3 - - contribute/index - -.. toctree:: - :caption: Developing - :maxdepth: 3 - - devel/index diff --git a/docs/install/core/docker/centos.rst b/docs/install/core/docker/centos.rst deleted file mode 100644 index 1ae2b578167..00000000000 --- a/docs/install/core/docker/centos.rst +++ /dev/null @@ -1,20 +0,0 @@ -Install the Docker and docker-compose packages on a CentOS host -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Docker Setup (First time only) -.............................. - -.. warning:: The `centos-extras` repository must be enabled - -.. code-block:: shell - - sudo yum install -y yum-utils device-mapper-persistent-data lvm2 - - sudo yum-config-manager --add-repo https://download.docker.com/linux/centos/docker-ce.repo - - sudo yum install docker-ce docker-ce-cli containerd.io - - sudo systemctl start docker - - sudo usermod -aG docker geonode - su geonode \ No newline at end of file diff --git a/docs/install/core/docker/ubuntu.rst b/docs/install/core/docker/ubuntu.rst deleted file mode 100644 index f6625839115..00000000000 --- a/docs/install/core/docker/ubuntu.rst +++ /dev/null @@ -1,24 +0,0 @@ -Install the Docker and docker-compose packages on a Ubuntu host -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Docker Setup (First time only) -.............................. - -.. code-block:: shell - - sudo add-apt-repository universe - sudo apt-get update -y - sudo apt-get install -y git-core git-buildpackage debhelper devscripts - sudo apt-get install -y apt-transport-https ca-certificates curl gnupg-agent software-properties-common - - curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add - - - sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable" - - sudo apt-get update -y - sudo apt-get install -y docker-ce docker-ce-cli containerd.io docker-compose - sudo apt autoremove --purge - - sudo usermod -aG docker geonode - su geonode - diff --git a/docs/install/core/img/ubuntu-https-001.png b/docs/install/core/img/ubuntu-https-001.png deleted file mode 100644 index a6d68c4b879..00000000000 Binary files a/docs/install/core/img/ubuntu-https-001.png and /dev/null differ diff --git a/docs/install/core/img/ubuntu-https-002.png b/docs/install/core/img/ubuntu-https-002.png deleted file mode 100644 index 280f57db858..00000000000 Binary files a/docs/install/core/img/ubuntu-https-002.png and /dev/null differ diff --git a/docs/install/core/img/ubuntu-https-003.png b/docs/install/core/img/ubuntu-https-003.png deleted file mode 100644 index 3ddf58228de..00000000000 Binary files a/docs/install/core/img/ubuntu-https-003.png and /dev/null differ diff --git a/docs/install/core/img/ubuntu-https-004.png b/docs/install/core/img/ubuntu-https-004.png deleted file mode 100644 index 5ec1d3d3e13..00000000000 Binary files a/docs/install/core/img/ubuntu-https-004.png and /dev/null differ diff --git a/docs/install/core/img/ubuntu-https-005.png b/docs/install/core/img/ubuntu-https-005.png deleted file mode 100644 index 4a607a2e315..00000000000 Binary files a/docs/install/core/img/ubuntu-https-005.png and /dev/null differ diff --git a/docs/install/core/index.rst b/docs/install/core/index.rst deleted file mode 100644 index 08eb2c901b1..00000000000 --- a/docs/install/core/index.rst +++ /dev/null @@ -1,1357 +0,0 @@ -============ -GeoNode Core -============ - -Overview -======== - -The following steps will guide you to a fresh setup of GeoNode. All guides will first install and configure the system to run it in ``DEBUG`` mode (also known as ``DEVELOPMENT`` mode) and then by configuring an HTTPD server to serve GeoNode through the standard ``HTTP`` (``80``) port. - -Those guides **are not** meant to be used on a production system. There will be dedicated chapters that will show you some *hints* to optimize GeoNode for a production-ready machine. In any case, we strongly suggest to task an experienced *DevOp* or *System Administrator* before exposing your server to the ``WEB``. - -Ubuntu 18.04 -============ - -This part of the documentation describes the complete setup process for GeoNode on an Ubuntu 18.04 64-bit clean environment (Desktop or Server). All examples use shell commands that you must enter on a local terminal or a remote shell. -- If you have a graphical desktop environment you can open the terminal application after login; -- if you are working on a remote server the provider or sysadmin should has given you access through an ssh client. - -.. _install_dep: - -Install the dependencies -^^^^^^^^^^^^^^^^^^^^^^^^ - -In this section, we are going to install all the basic packages and tools needed for a complete GeoNode installation. To follow this guide, a basic knowledge about Ubuntu Server configuration and working with a shell is required. This guide uses ``vim`` as the editor; fill free to use ``nano``, ``gedit`` or others. - -Upgrade system packages -....................... - -Check that your system is already up-to-date with the repository running the following commands: - -.. code-block:: shell - - sudo apt update - sudo apt upgrade - - -Packages Installation -..................... - -.. note:: You don't need to install the **system packages** if you want to run the project using Docker - -We will use **example.org** as fictitious Domain Name. - -First, we are going to install all the **system packages** needed for the GeoNode setup. Login to the target machine and execute the following commands: - -.. code-block:: shell - - # Install packages from GeoNode core - sudo apt install -y gdal-bin - sudo apt install -y python3-pip python3-dev python3-virtualenv python3-venv virtualenvwrapper - sudo apt install -y libxml2 libxml2-dev gettext - sudo apt install -y libxslt1-dev libjpeg-dev libpng-dev libpq-dev libgdal-dev libgdal20 - sudo apt install -y software-properties-common build-essential - sudo apt install -y git unzip gcc zlib1g-dev libgeos-dev libproj-dev - sudo apt install -y sqlite3 spatialite-bin libsqlite3-mod-spatialite - - # Install Openjdk - sudo -i apt update - sudo apt install openjdk-8-jdk-headless default-jdk-headless -y - sudo update-java-alternatives --jre-headless --jre --set java-1.8.0-openjdk-amd64 - - # Install VIM - sudo apt install -y vim - - sudo apt update -y - sudo apt upgrade -y - sudo apt autoremove -y - sudo apt autoclean -y - sudo apt purge -y - sudo apt clean -y - -Create a Dedicated User -....................... - -In the following steps a User named ``geonode`` is created (if needed) and used: to run installation commands the user must be in the ``sudo`` group. - -Create User ``geonode`` **if not present**: - -.. code-block:: shell - - # Follow the prompts to set the new user's information. - # It is fine to accept the defaults to leave all of this information blank. - sudo adduser geonode - - # The following command adds the user geonode to group sudo - sudo usermod -aG sudo geonode - - # make sure the newly created user is allowed to login by ssh - # (out of the scope of this documentation) and switch to User geonode - su geonode - -GeoNode Installation -^^^^^^^^^^^^^^^^^^^^ - -This is the most basic installation of GeoNode. It won't use any external server like ``Apache Tomcat``, ``PostgreSQL`` or ``HTTPD``. - -It will run locally against a file-system based ``SQLite`` database. - - -First of all we need to prepare a new Python Virtual Environment - -Since geonode needs a large number of different python libraries and packages, it's recommended to use a python virtual environment to avoid conflicts on dependencies with system wide python packages and other installed software. See also documentation of `Virtualenvwrapper `_ package for more information - -.. code-block:: shell - - # Create the GeoNode Virtual Environment (first time only) - source /usr/share/virtualenvwrapper/virtualenvwrapper.sh - mkvirtualenv --python=/usr/bin/python3 geonode - -At this point your command prompt shows a ``(geonode)`` prefix, this indicates that your virtualenv is active. - -.. note:: The next time you need to access the Virtual Environment just run - - .. code-block:: shell - - source /usr/share/virtualenvwrapper/virtualenvwrapper.sh - workon geonode - -.. note:: In order to save permanently the virtualenvwrapper envioroment - - .. code-block:: shell - - nano ~/.bashrc - - # Write to the bottom of the file the following lines - export WORKON_HOME=/home/geonode/.virtualenvs - source /usr/share/virtualenvwrapper/virtualenvwrapper.sh - -.. code-block:: shell - - # Let's create the GeoNode core base folder and clone it - sudo mkdir -p /opt/geonode/ - sudo usermod -a -G www-data geonode - sudo chown -Rf geonode:www-data /opt/geonode/ - sudo chmod -Rf 775 /opt/geonode/ - - # Clone the GeoNode source code on /opt/geonode - cd /opt - git clone https://github.com/GeoNode/geonode.git geonode - - # Install the Python packages - cd /opt/geonode - pip install -r requirements.txt --upgrade --no-cache --no-cache-dir - pip install -e . --upgrade - - # Install GDAL Utilities for Python - pip install pygdal=="`gdal-config --version`.*" - -Run GeoNode for the first time in DEBUG Mode -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. warning:: - - Be sure you have successfully completed all the steps of the section :ref:`install_dep`. - -This command will run both GeoNode and GeoServer locally after having prepared the SQLite database. The server will start in ``DEBUG`` (or ``DEVELOPMENT``) mode, and it will start the following services: - -#. GeoNode on ``http://localhost:8000/`` -#. GeoServer on ``http://localhost:8080/geoserver/`` - -This modality is beneficial to debug issues and/or develop new features, but it cannot be used on a production system. - -.. code-block:: shell - - # Prepare the GeoNode SQLite database (the first time only) - paver setup - paver sync - -.. note:: - - In case you want to start again from a clean situation, just run - - .. code:: shell - - paver reset_hard - -.. warning:: This will blow up completely your ``local_settings``, delete the SQLlite database and remove the GeoServer data dir. - -.. code-block:: shell - - # Run the server in DEBUG mode - paver start - -Once the server has finished the initialization and prints on the console the sentence ``GeoNode is now available.``, you can open a browser and go to:: - - http://localhost:8000/ - -Sign-in with:: - - user: admin - password: admin - -.. _configure_dbs_core: - -Postgis database Setup -^^^^^^^^^^^^^^^^^^^^^^ - -.. warning:: - - Be sure you have successfully completed all the steps of the section :ref:`install_dep`. - -In this section, we are going to setup users and databases for GeoNode in PostgreSQL. - -Install and Configure the PostgreSQL Database System -.................................................... - -In this section we are going to install the ``PostgreSQL`` packages along with the ``PostGIS`` extension. Those steps must be done **only** if you don't have the DB already installed on your system. - -.. code-block:: shell - - sudo sh -c 'echo "deb http://apt.postgresql.org/pub/repos/apt/ `lsb_release -cs`-pgdg main" >> /etc/apt/sources.list.d/pgdg.list' - sudo wget --no-check-certificate --quiet -O - https://www.postgresql.org/media/keys/ACCC4CF8.asc | sudo apt-key add - - - sudo apt update - sudo apt install -y postgresql-11 postgresql-11-postgis-2.5 postgresql-11-postgis-2.5-scripts postgresql-contrib-11 postgresql-client-11 - -We now must create two databases, ``geonode`` and ``geonode_data``, belonging to the role ``geonode``. - -.. note:: This is our default configuration. You can use any database or role you need. The connection parameters must be correctly configured on ``settings``, as we will see later in this section. - -Databases and Permissions -......................... - -First, create the geonode user. GeoNode is going to use this user to access the database - -.. code-block:: shell - - sudo -u postgres createuser -P geonode - -You will be prompted asked to set a password for the user. Enter ``geonode`` as password. - -.. warning:: This is a sample password used for the sake of simplicity. This password is very **weak** and should be changed in a production environment. - -Create database ``geonode`` and ``geonode_data`` with owner ``geonode`` - -.. code-block:: shell - - sudo -u postgres createdb -O geonode geonode - sudo -u postgres createdb -O geonode geonode_data - -Next let's create PostGIS extensions - -.. code-block:: shell - - sudo -u postgres psql -d geonode_data -c 'CREATE EXTENSION postgis;' - sudo -u postgres psql -d geonode_data -c 'GRANT ALL ON geometry_columns TO PUBLIC;' - sudo -u postgres psql -d geonode_data -c 'GRANT ALL ON spatial_ref_sys TO PUBLIC;' - sudo -u postgres psql -d geonode_data -c 'GRANT ALL PRIVILEGES ON ALL TABLES IN SCHEMA public TO geonode;' - -Final step is to change user access policies for local connections in the file ``pg_hba.conf`` - -.. code-block:: shell - - sudo vim /etc/postgresql/11/main/pg_hba.conf - -Scroll down to the bottom of the document. We only need to edit one line. - -.. code-block:: shell - - # "local" is for Unix domain socket connections only - # local all all peer - local all all trust - -.. warning:: If your ``PostgreSQL`` database resides on a **separate/remote machine**, you'll have to **allow** remote access to the databases in the ``/etc/postgresql/11/main/pg_hba.conf`` to the ``geonode`` user and tell PostgreSQL to **accept** non-local connections in your ``/etc/postgresql/11/main/postgresql.conf`` file - -Restart PostgreSQL to make the change effective. - -.. code-block:: shell - - sudo service postgresql restart - -PostgreSQL is now ready. To test the configuration, try to connect to the ``geonode`` database as ``geonode`` role. - -.. code-block:: shell - - psql -U geonode geonode - \q - - -Install GeoServer -^^^^^^^^^^^^^^^^^ - -When running the command ``paver start``, as we have seen before, the script runs automatically a ``Jetty`` Servlet Java container running ``GeoServer`` with the default settings. - -.. warning:: Before executing the next steps, be sure ``GeoNode`` and ``GeoServer`` paver services have been stopped. In order to do that - - .. code-block:: shell - - workon geonode - cd /opt/geonode/ - paver stop - -This is not the optimal way to run ``GeoServer``. This is a fundamental component of ``GeoNode`` and we must be sure it is running on a stable and reliable manner. - -In this section, we are going to install the ``Apache Tomcat 8`` Servlet Java container, which will be started by default on the internal port ``8080``. - -We will also perform several optimizations to: - -1. Correctly setup the Java VM Options, like the available heap memory and the garbage collector options. -2. Externalize the ``GeoServer`` and ``GeoWebcache`` catalogs in order to allow further updates without the risk of deleting our datasets. - -.. note:: This is still a basic setup of those components. More details will be provided on sections of the documentation concerning the hardening of the system in a production environment. Nevertheless, you will need to tweak a bit those settings accordingly with your current system. As an instance, if your machine does not have enough memory, you will need to lower down the initial amount of available heap memory. **Warnings** and **notes** will be placed below the statements that will require your attention. - -.. code-block:: shell - - # Install Openjdk - sudo -i apt update - sudo apt install openjdk-8-jdk-headless default-jdk-headless -y - sudo update-java-alternatives --jre-headless --jre --set java-1.8.0-openjdk-amd64 - - # Check Java version - java -version - openjdk version "1.8.0_212" - OpenJDK Runtime Environment (build 1.8.0_212-8u212-b03-0ubuntu1.18.04.1-b03) - OpenJDK 64-Bit Server VM (build 25.212-b03, mixed mode) - - # Install Apache Tomcat 8 - sudo wget http://www-us.apache.org/dist/tomcat/tomcat-8/v8.5.50/bin/apache-tomcat-8.5.50.tar.gz - sudo tar xzf apache-tomcat-8.5.50.tar.gz - sudo mv apache-tomcat-8.5.50 /usr/local/apache-tomcat8 - sudo useradd -m -U -s /bin/false tomcat - sudo usermod -a -G www-data tomcat - sudo sed -i -e 's/xom-\*\.jar/xom-\*\.jar,bcprov\*\.jar/g' /usr/local/apache-tomcat8/conf/catalina.properties - - export JAVA_HOME=$(readlink -f /usr/bin/java | sed "s:bin/java::") - echo 'JAVA_HOME='$JAVA_HOME | sudo tee --append /usr/local/apache-tomcat8/bin/setenv.sh - - # Add Tomcat user to www-data group !important! - sudo usermod -a -G www-data tomcat - - sudo sh -c 'chmod +x /usr/local/apache-tomcat8/bin/*.sh' - sudo chown -Rf tomcat:www-data /usr/local/apache-tomcat8 - -Let's create a system service to manage tomcat startup - -.. code-block:: shell - - sudo vim /etc/systemd/system/tomcat.service - -.. code-block:: shell - - [Unit] - Description=Tomcat 8.5 servlet container - After=network.target - - [Service] - Type=forking - - User=tomcat - Group=tomcat - - Environment="JAVA_HOME=/usr/lib/jvm/default-java" - Environment="JAVA_OPTS=-Djava.security.egd=file:///dev/urandom" - - Environment="CATALINA_BASE=/usr/local/apache-tomcat8" - Environment="CATALINA_HOME=/usr/local/apache-tomcat8" - Environment="CATALINA_PID=/usr/local/apache-tomcat8/temp/tomcat.pid" - - ExecStart=/usr/local/apache-tomcat8/bin/startup.sh - ExecStop=/usr/local/apache-tomcat8/bin/shutdown.sh - - [Install] - WantedBy=multi-user.target - -To test the service: - -.. code-block:: shell - - sudo systemctl daemon-reload - sudo systemctl restart tomcat - sudo systemctl status tomcat.service - -To make it enabled by default - -.. code-block:: shell - - sudo systemctl enable tomcat - -GeoServer Optimizations -....................... - -Let's externalize the ``GEOSERVER_DATA_DIR`` and ``logs`` - -.. code-block:: shell - - # Create the target folders - sudo mkdir -p /opt/data - sudo chown -Rf geonode:www-data /opt/data - sudo chmod -Rf 775 /opt/data - sudo mkdir -p /opt/data/logs - sudo chown -Rf geonode:www-data /opt/data/logs - sudo chmod -Rf 775 /opt/data/logs - - # Download and extract the default GEOSERVER_DATA_DIR - sudo wget --no-check-certificate https://build.geo-solutions.it/geonode/geoserver/latest/data-2.16.2.zip - sudo unzip data-2.16.2.zip -d /opt/data/ - - sudo mv /opt/data/data/ /opt/data/geoserver_data - sudo chown -Rf tomcat:www-data /opt/data/geoserver_data - sudo chmod -Rf 775 /opt/data/geoserver_data - - sudo mkdir -p /opt/data/geoserver_logs - sudo chown -Rf tomcat:www-data /opt/data/geoserver_logs - sudo chmod -Rf 775 /opt/data/geoserver_logs - - sudo mkdir -p /opt/data/gwc_cache_dir - sudo chown -Rf tomcat:www-data /opt/data/gwc_cache_dir - sudo chmod -Rf 775 /opt/data/gwc_cache_dir - - # Download and install GeoServer - sudo wget --no-check-certificate https://build.geo-solutions.it/geonode/geoserver/latest/geoserver-2.16.2.war - sudo mv geoserver-2.16.2.war /usr/local/apache-tomcat8/webapps/geoserver.war - -Let's now configure the ``JAVA_OPTS``, i.e. the parameters to run the Servlet Container, like heap memory, garbage collector and so on. - -.. code-block:: shell - - sudo sed -i -e "s/JAVA_OPTS=/#JAVA_OPTS=/g" /usr/local/apache-tomcat8/bin/setenv.sh - - echo 'GEOSERVER_DATA_DIR="/opt/data/geoserver_data"' | sudo tee --append /usr/local/apache-tomcat8/bin/setenv.sh - echo 'GEOSERVER_LOG_LOCATION="/opt/data/geoserver_logs/geoserver.log"' | sudo tee --append /usr/local/apache-tomcat8/bin/setenv.sh - echo 'GEOWEBCACHE_CACHE_DIR="/opt/data/gwc_cache_dir"' | sudo tee --append /usr/local/apache-tomcat8/bin/setenv.sh - echo 'GEOFENCE_DIR="$GEOSERVER_DATA_DIR/geofence"' | sudo tee --append /usr/local/apache-tomcat8/bin/setenv.sh - echo 'TIMEZONE="UTC"' | sudo tee --append /usr/local/apache-tomcat8/bin/setenv.sh - - echo 'JAVA_OPTS="-server -Djava.awt.headless=true -Dorg.geotools.shapefile.datetime=true -XX:+UseParallelGC -XX:ParallelGCThreads=4 -Dfile.encoding=UTF8 -Duser.timezone=$TIMEZONE -Xms512m -Xmx4096m -Djavax.servlet.request.encoding=UTF-8 -Djavax.servlet.response.encoding=UTF-8 -DGEOSERVER_CSRF_DISABLED=true -DGEOSERVER_DATA_DIR=$GEOSERVER_DATA_DIR -Dgeofence.dir=$GEOFENCE_DIR -DGEOSERVER_LOG_LOCATION=$GEOSERVER_LOG_LOCATION -DGEOWEBCACHE_CACHE_DIR=$GEOWEBCACHE_CACHE_DIR"' | sudo tee --append /usr/local/apache-tomcat8/bin/setenv.sh - -.. note:: After the execution of the above statements, you should be able to see the new options written at the bottom of the file ``/usr/local/apache-tomcat8/bin/setenv.sh``. - - .. code-block:: shell - - ... - # If you run Tomcat on port numbers that are all higher than 1023, then you - # do not need authbind. It is used for binding Tomcat to lower port numbers. - # (yes/no, default: no) - #AUTHBIND=no - JAVA_HOME=/usr/lib/jvm/java-8-openjdk-amd64/jre/ - GEOSERVER_DATA_DIR="/opt/data/geoserver_data" - GEOSERVER_LOG_LOCATION="/opt/data/geoserver_logs/geoserver.log" - GEOWEBCACHE_CACHE_DIR="/opt/data/gwc_cache_dir" - GEOFENCE_DIR="$GEOSERVER_DATA_DIR/geofence" - TIMEZONE="UTC" - JAVA_OPTS="-server -Djava.awt.headless=true -Dorg.geotools.shapefile.datetime=true -XX:+UseParallelGC -XX:ParallelGCThreads=4 -Dfile.encoding=UTF8 -Duser.timezone=$TIMEZONE -Xms512m -Xmx4096m -Djavax.servlet.request.encoding=UTF-8 -Djavax.servlet.response.encoding=UTF-8 -DGEOSERVER_CSRF_DISABLED=true -DGEOSERVER_DATA_DIR=$GEOSERVER_DATA_DIR -Dgeofence.dir=$GEOFENCE_DIR -DGEOSERVER_LOG_LOCATION=$GEOSERVER_LOG_LOCATION -DGEOWEBCACHE_CACHE_DIR=$GEOWEBCACHE_CACHE_DIR" - - Those options could be updated or changed manually at any time, accordingly to your needs. - -.. warning:: The default options we are going to add to the Servlet Container, assume you can reserve at least ``4GB`` of ``RAM`` to ``GeoServer`` (see the option ``-Xmx4096m``). You must be sure your machine has enough memory to run both ``GeoServer`` and ``GeoNode``, which in this case means at least ``4GB`` for ``GeoServer`` plus at least ``2GB`` for ``GeoNode``. A total of at least ``6GB`` of ``RAM`` available on your machine. If you don't have enough ``RAM`` available, you can lower down the values ``-Xms512m -Xmx4096m``. Consider that with less ``RAM`` available, the performances of your services will be highly impacted. - -In order to make the changes effective, you'll need to restart the Servlet Container. - -.. code-block:: shell - - # Restart the server - sudo systemctl daemon-reload - sudo systemctl restart tomcat - sudo systemctl status tomcat.service - - # Follow the startup logs - sudo tail -F -n 300 /opt/data/geoserver_logs/geoserver.log - -If you can see on the logs something similar to this, without errors - -.. code-block:: shell - - ... - 2019-05-31 10:06:34,190 INFO [geoserver.wps] - Found 5 bindable processes in GeoServer specific processes - 2019-05-31 10:06:34,281 INFO [geoserver.wps] - Found 89 bindable processes in Deprecated processes - 2019-05-31 10:06:34,298 INFO [geoserver.wps] - Found 31 bindable processes in Vector processes - 2019-05-31 10:06:34,307 INFO [geoserver.wps] - Found 48 bindable processes in Geometry processes - 2019-05-31 10:06:34,307 INFO [geoserver.wps] - Found 1 bindable processes in PolygonLabelProcess - 2019-05-31 10:06:34,311 INFO [geoserver.wps] - Blacklisting process ras:ConvolveCoverage as the input kernel of type class javax.media.jai.KernelJAI cannot be handled - 2019-05-31 10:06:34,319 INFO [geoserver.wps] - Blacklisting process ras:RasterZonalStatistics2 as the input zones of type class java.lang.Object cannot be handled - 2019-05-31 10:06:34,320 INFO [geoserver.wps] - Blacklisting process ras:RasterZonalStatistics2 as the input nodata of type class it.geosolutions.jaiext.range.Range cannot be handled - 2019-05-31 10:06:34,320 INFO [geoserver.wps] - Blacklisting process ras:RasterZonalStatistics2 as the input rangeData of type class java.lang.Object cannot be handled - 2019-05-31 10:06:34,320 INFO [geoserver.wps] - Blacklisting process ras:RasterZonalStatistics2 as the output zonal statistics of type interface java.util.List cannot be handled - 2019-05-31 10:06:34,321 INFO [geoserver.wps] - Found 18 bindable processes in Raster processes - 2019-05-31 10:06:34,917 INFO [ows.OWSHandlerMapping] - Mapped URL path [/TestWfsPost] onto handler 'wfsTestServlet' - 2019-05-31 10:06:34,918 INFO [ows.OWSHandlerMapping] - Mapped URL path [/wfs/*] onto handler 'dispatcher' - 2019-05-31 10:06:34,918 INFO [ows.OWSHandlerMapping] - Mapped URL path [/wfs] onto handler 'dispatcher' - 2019-05-31 10:06:42,237 INFO [geoserver.security] - Start reloading user/groups for service named default - 2019-05-31 10:06:42,241 INFO [geoserver.security] - Reloading user/groups successful for service named default - 2019-05-31 10:06:42,357 WARN [auth.GeoFenceAuthenticationProvider] - INIT FROM CONFIG - 2019-05-31 10:06:42,494 INFO [geoserver.security] - AuthenticationCache Initialized with 1000 Max Entries, 300 seconds idle time, 600 seconds time to live and 3 concurrency level - 2019-05-31 10:06:42,495 INFO [geoserver.security] - AuthenticationCache Eviction Task created to run every 600 seconds - 2019-05-31 10:06:42,506 INFO [config.GeoserverXMLResourceProvider] - Found configuration file in /opt/data/gwc_cache_dir - 2019-05-31 10:06:42,516 INFO [config.GeoserverXMLResourceProvider] - Found configuration file in /opt/data/gwc_cache_dir - 2019-05-31 10:06:42,542 INFO [config.XMLConfiguration] - Wrote configuration to /opt/data/gwc_cache_dir - 2019-05-31 10:06:42,547 INFO [geoserver.importer] - Enabling import store: memory - -Your ``GeoServer`` should be up and running at - -.. code-block:: shell - - http://localhost:8080/geoserver/ - -.. warning:: In case of errors or the file ``geoserver.log`` is not created, check the Catalina logs in order to try to understand what's happened. - - .. code-block:: shell - - sudo less /usr/local/apache-tomcat8/logs/catalina.out - -It is possible to test the new running ``GeoServer`` with the ``GeoNode`` paver service (``DEBUG`` mode). To do that - -.. code-block:: shell - - workon geonode - cd /opt/geonode/ - paver start_django - -.. warning:: The ``paver reset`` command from now on **won't** clean up ``GeoServer`` and its catalog anymore. Therefore, every data uploaded during those tests will remain on ``GeoServer`` even if ``GeoNode`` will be reset. - -Web Server -^^^^^^^^^^ - -Until now we have seen how to start ``GeoNode`` in ``DEBUG`` mode from the command line, through the ``paver`` utilities. This is of course not the best way to start it. Moreover you will need a dedicated ``HTTPD`` server running on port ``80`` if you would like to expose your server to the world. - -In this section we will see: - -1. How to configure ``NGINX`` HTTPD Server to host ``GeoNode`` and ``GeoServer``. In the initial setup we will still run the services on ``http://localhost`` -2. Update the ``settings`` in order to link ``GeoNode`` and ``GeoServer`` to the ``PostgreSQL`` Database. -3. Update the ``settings`` in order to update ``GeoNode`` and ``GeoServer`` services running on a **public IP** or **hostname**. -4. Install and enable ``HTTPS`` secured connection through the ``Let's Encrypt`` provider. - -Install and configure NGINX -........................... - -.. warning:: Before executing the next steps, be sure ``GeoNode`` paver services have been stopped. To do that - - .. code-block:: shell - - workon geonode - cd /opt/geonode/ - paver stop_django - -.. code-block:: shell - - # Install the services - sudo apt install -y nginx uwsgi uwsgi-plugin-python3 - -Serving {“geonode”, “geoserver”} via NGINX -.......................................... - -.. code-block:: shell - - # Create the GeoNode UWSGI config - sudo vim /etc/uwsgi/apps-available/geonode.ini - -.. code-block:: shell - - [uwsgi] - socket = 0.0.0.0:8000 - uid = geonode - gid = www-data - - plugins = python - virtualenv = /home/geonode/.virtualenvs/geonode - env = DEBUG=False - env = DJANGO_SETTINGS_MODULE=geonode.settings - env = SECRET_KEY='RanD0m%3cr3tK3y' - env = SITE_HOST_NAME=localhost - env = SITEURL=http://localhost/ - env = LOCKDOWN_GEONODE=False - env = SESSION_EXPIRED_CONTROL_ENABLED=True - env = FORCE_SCRIPT_NAME= - env = EMAIL_ENABLE=False - env = DJANGO_EMAIL_HOST_USER= - env = DJANGO_EMAIL_HOST_PASSWORD= - env = DJANGO_EMAIL_HOST=localhost - env = DJANGO_EMAIL_PORT=25 - env = DJANGO_EMAIL_USE_TLS=False - env = DEFAULT_FROM_EMAIL=GeoNode - env = MONITORING_ENABLED=True - env = GEOSERVER_PUBLIC_HOST=localhost - env = GEOSERVER_PUBLIC_PORT= - env = GEOSERVER_ADMIN_PASSWORD=geoserver - env = GEOSERVER_LOCATION=http://localhost/geoserver/ - env = GEOSERVER_PUBLIC_LOCATION=http://localhost/geoserver/ - env = GEOSERVER_WEB_UI_LOCATION=http://localhost/geoserver/ - env = RESOURCE_PUBLISHING=False - env = ADMIN_MODERATE_UPLOADS=False - env = GROUP_PRIVATE_RESOURCES=False - env = GROUP_MANDATORY_RESOURCES=False - env = OGC_REQUEST_TIMEOUT=60 - env = OGC_REQUEST_MAX_RETRIES=3 - env = OGC_REQUEST_POOL_MAXSIZE=100 - env = OGC_REQUEST_POOL_CONNECTIONS=100 - env = EXIF_ENABLED=True - env = CREATE_LAYER=False - env = FAVORITE_ENABLED=True - - chdir = /opt/geonode - module = geonode.wsgi:application - - processes = 4 - threads = 2 - enable-threads = true - master = true - - # logging - # path to where uwsgi logs will be saved - logto = /opt/data/logs/geonode.log - daemonize = /opt/data/logs/geonode.log - touch-reload = /opt/geonode/geonode/wsgi.py - buffer-size = 32768 - max-requests = 500 - harakiri = 300 # respawn processes taking more than 5 minutes (300 seconds) - max-requests = 500 # respawn processes after serving 5000 requests - # limit-as = 1024 # avoid Errno 12 cannot allocate memory - harakiri-verbose = true - vacuum = true - thunder-lock = true - -.. code-block:: shell - - # Enable the GeoNode UWSGI config - sudo ln -s /etc/uwsgi/apps-available/geonode.ini /etc/uwsgi/apps-enabled/geonode.ini - - # Restart UWSGI Service - sudo service uwsgi restart - -.. code-block:: shell - - # Backup the original NGINX config - sudo mv /etc/nginx/nginx.conf /etc/nginx/nginx.conf.orig - - # Create the GeoNode Default NGINX config - sudo vim /etc/nginx/nginx.conf - -.. code-block:: shell - - # Make sure your nginx.config matches the following one - user www-data; - worker_processes auto; - pid /run/nginx.pid; - include /etc/nginx/modules-enabled/*.conf; - - events { - worker_connections 768; - # multi_accept on; - } - - http { - ## - # Basic Settings - ## - - sendfile on; - tcp_nopush on; - tcp_nodelay on; - keepalive_timeout 65; - types_hash_max_size 2048; - # server_tokens off; - - # server_names_hash_bucket_size 64; - # server_name_in_redirect off; - - include /etc/nginx/mime.types; - default_type application/octet-stream; - - ## - # SSL Settings - ## - - ssl_protocols TLSv1 TLSv1.1 TLSv1.2; # Dropping SSLv3, ref: POODLE - ssl_prefer_server_ciphers on; - - ## - # Logging Settings - ## - - access_log /var/log/nginx/access.log; - error_log /var/log/nginx/error.log; - - ## - # Gzip Settings - ## - - gzip on; - gzip_vary on; - gzip_proxied any; - gzip_http_version 1.1; - gzip_disable "MSIE [1-6]\."; - gzip_buffers 16 8k; - gzip_min_length 1100; - gzip_comp_level 6; - gzip_proxied any; - gzip_types video/mp4 text/plain application/javascript application/x-javascript text/javascript text/xml text/css image/jpeg; - - ## - # Virtual Host Configs - ## - - include /etc/nginx/conf.d/*.conf; - include /etc/nginx/sites-enabled/*; - } - -.. code-block:: shell - - # Remove the Default NGINX config - sudo rm /etc/nginx/sites-enabled/default - - # Create the GeoNode App NGINX config - sudo vim /etc/nginx/sites-available/geonode - -.. code-block:: shell - - uwsgi_intercept_errors on; - - upstream geoserver_proxy { - server localhost:8080; - } - - # Expires map - map $sent_http_content_type $expires { - default off; - text/html epoch; - text/css max; - application/javascript max; - ~image/ max; - } - - server { - listen 80 default_server; - listen [::]:80 default_server; - - root /var/www/html; - index index.html index.htm index.nginx-debian.html; - - server_name _; - - charset utf-8; - - etag on; - expires $expires; - proxy_read_timeout 600s; - # set client body size to 2M # - client_max_body_size 50000M; - - location / { - etag off; - uwsgi_pass 127.0.0.1:8000; - uwsgi_read_timeout 600s; - include uwsgi_params; - } - - location /static/ { - alias /opt/geonode/geonode/static_root/; - } - - location /uploaded/ { - alias /opt/geonode/geonode/uploaded/; - } - - location /geoserver { - proxy_pass http://geoserver_proxy; - include proxy_params; - } - } - -.. code-block:: shell - - # Enable GeoNode NGINX config - sudo ln -s /etc/nginx/sites-available/geonode /etc/nginx/sites-enabled/geonode - - # Restart the services - sudo systemctl restart tomcat - sudo service nginx restart - -Refresh ``GeoNode`` static data - -.. code-block:: shell - - workon geonode - cd /opt/geonode - python manage.py collectstatic --no-input - - -Refresh ``GeoNode`` and ``GeoServer`` **OAuth2** settings - -.. code-block:: shell - - workon geonode - cd /opt/geonode - - # This must be done the first time only - sudo cp package/support/geonode.binary /usr/bin/geonode - sudo cp package/support/geonode.updateip /usr/bin/geonode_updateip - sudo chmod +x /usr/bin/geonode - sudo chmod +x /usr/bin/geonode_updateip - pip install -e git+https://github.com/justquick/django-activity-stream.git#egg=django-activity-stream - - # Update the GeoNode ip or hostname - sudo PYTHONWARNINGS=ignore VIRTUAL_ENV=$VIRTUAL_ENV DJANGO_SETTINGS_MODULE=geonode.settings GEONODE_ETC=/opt/geonode GEOSERVER_DATA_DIR=/opt/data/geoserver_data TOMCAT_SERVICE="service tomcat" APACHE_SERVICE="service nginx" geonode_updateip -p localhost - -The ``GeoNode`` service should now run on ``http://localhost/`` - -The ``GeoServer`` service should now run on ``http://localhost/geoserver/`` - -You should be able to login with the default user ``admin`` (pwd ``admin``) and upload your layers. - -Update the settings in order to use the ``PostgreSQL`` Database -............................................................... - -.. warning:: Make sure you already installed and configured the Database as explained in the previous sections. - -.. code-block:: shell - - workon geonode - cd /opt/geonode - - cp geonode/local_settings.py.geoserver.sample geonode/local_settings.py - - # In case you want to change the DB password, run the following - # sudo sed -i -e "s/'PASSWORD': 'geonode',/'PASSWORD': '',/g" geonode/local_settings.py - - # Stop Tomcat - sudo systemctl stop tomcat - - # Initialize GeoNode - DJANGO_SETTINGS_MODULE=geonode.local_settings paver reset - DJANGO_SETTINGS_MODULE=geonode.local_settings paver setup - DJANGO_SETTINGS_MODULE=geonode.local_settings paver sync - DJANGO_SETTINGS_MODULE=geonode.local_settings python manage.py collectstatic --noinput - -Before finalizing the configuration we will need to update the ``UWSGI`` settings - -.. code-block:: shell - - sudo vim /etc/uwsgi/apps-enabled/geonode.ini - -Change ``geonode.settings`` to ``geonode.local_settings`` - -.. code-block:: shell - - :%s/geonode.settings/geonode.local_settings/g - :wq - -Restart ``UWSGI`` and update ``OAuth2`` by using the new ``geonode.local_settings`` - -.. warning:: **!IMPORTANT!** In the statement below make sure to use ``DJANGO_SETTINGS_MODULE=geonode.local_settings`` - -.. code-block:: shell - - # Restart UWSGI - sudo service uwsgi restart - - # Update the GeoNode ip or hostname - sudo PYTHONWARNINGS=ignore VIRTUAL_ENV=$VIRTUAL_ENV DJANGO_SETTINGS_MODULE=geonode.local_settings GEONODE_ETC=/opt/geonode GEOSERVER_DATA_DIR=/opt/data/geoserver_data TOMCAT_SERVICE="service tomcat" APACHE_SERVICE="service nginx" geonode_updateip -p localhost - -Update the settings in order to update GeoNode and GeoServer services running on a public IP or hostname -........................................................................................................ - -.. warning:: Before exposing your services to the Internet, **make sure** your system is **hardened** and **secure enough**. See the specific documentation section for more details. - -Let's say you want to run your services on a public IP or domain, e.g. ``www.example.org``. You will need to slightly update your services in order to reflect the new server name. - -In particular the steps to do are: - -1. Update ``NGINX`` configuration in order to serve the new domain name. - - .. code-block:: shell - - sudo vim /etc/nginx/sites-enabled/geonode - - # Update the 'server_name' directive - server_name example.org www.example.org; - - # Restart the service - sudo service nginx restart - -2. Update ``UWSGI`` configuration in order to serve the new domain name. - - .. code-block:: shell - - sudo vim /etc/uwsgi/apps-enabled/geonode.ini - - # Change everywhere 'localhost' to the new hostname - %s/localhost/www.example.org/g - - # Restart the service - sudo service uwsgi restart - -3. Update ``OAuth2`` configuration in order to hit the new hostname. - - .. code-block:: shell - - workon geonode - cd /opt/geonode - - # Update the GeoNode ip or hostname - sudo PYTHONWARNINGS=ignore VIRTUAL_ENV=$VIRTUAL_ENV DJANGO_SETTINGS_MODULE=geonode.local_settings GEONODE_ETC=/opt/geonode GEOSERVER_DATA_DIR=/opt/data/geoserver_data TOMCAT_SERVICE="service tomcat" APACHE_SERVICE="service nginx" geonode_updateip -l localhost -p www.example.org - -4. Update the existing ``GeoNode`` links in order to hit the new hostname. - - .. code-block:: shell - - workon geonode - cd /opt/geonode - - # Update the GeoNode ip or hostname - DJANGO_SETTINGS_MODULE=geonode.local_settings python manage.py migrate_baseurl --source-address=http://localhost --target-address=http://www.example.org - -Install and enable HTTPS secured connection through the Let's Encrypt provider -.............................................................................. - -.. code-block:: shell - - # Install Let's Encrypt Certbot - sudo add-apt-repository ppa:certbot/certbot - sudo apt update -y; sudo apt install python-certbot-nginx -y - - # Reload NGINX config and make sure the firewall denies access to HTTP - sudo systemctl reload nginx - sudo ufw allow 'Nginx Full' - sudo ufw delete allow 'Nginx HTTP' - - # Create and dump the Let's Encrypt Certificates - sudo certbot --nginx -d example.org -d www.example.org - # ...choose the redirect option when asked for - -1. Update the ``GeoNode`` **OAuth2** ``Redirect URIs`` accordingly. - - From the ``GeoNode Admin Dashboard`` go to ``Home › Django/GeoNode OAuth Toolkit › Applications › GeoServer`` - - .. figure:: img/ubuntu-https-001.png - :align: center - - *Redirect URIs* - -2. Update the ``GeoServer`` ``Proxy Base URL`` accordingly. - - From the ``GeoServer Admin GUI`` go to ``About & Status > Global`` - - .. figure:: img/ubuntu-https-002.png - :align: center - - *Proxy Base URL* - - -3. Update the ``GeoServer`` ``Role Base URL`` accordingly. - - From the ``GeoServer Admin GUI`` go to ``Security > Users, Groups, Roles > geonode REST role service`` - - .. figure:: img/ubuntu-https-003.png - :align: center - - *Role Base URL* - -4. Update the ``GeoServer`` ``OAuth2 Service Parameters`` accordingly. - - From the ``GeoServer Admin GUI`` go to ``Security > Authentication > Authentication Filters > geonode-oauth2`` - - .. figure:: img/ubuntu-https-004.png - :align: center - - *OAuth2 Service Parameters* - - -5. Update the ``UWSGI`` configuration - - .. code-block:: shell - - sudo vim /etc/uwsgi/apps-enabled/geonode.ini - - # Change everywhere 'http' to 'https' - %s/http/https/g - - # Add three more 'env' variables to the configuration - env = SECURE_SSL_REDIRECT=True - env = SECURE_HSTS_INCLUDE_SUBDOMAINS=True - env = AVATAR_GRAVATAR_SSL=True - - # Restart the service - sudo service uwsgi restart - - .. figure:: img/ubuntu-https-005.png - :align: center - - *UWSGI Configuration* - -CentOS 7.0 -========== - -* TODO - -Docker -====== - -In this section we are going to list the passages needed to: - -1. Install ``Docker`` and ``docker-compose`` packages on a Ubuntu host -2. Deploy a vanilla ``GeoNode 2.10`` with ``Docker`` - - a. Override the ``ENV`` variables to deploy on a ``public IP`` or ``domain`` - b. Access the ``django4geonode`` Docker image to update the code-base and/or change internal settings - c. Access the ``geoserver4geonode`` Docker image to update the GeoServer version - -3. Passages to completely get rid of old ``Docker`` images and volumes (prune the environment completely) - -.. include:: docker/ubuntu.rst - -.. include:: docker/centos.rst - -Test Docker Compose Instance -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Logout and login again on shell and then execute: - -.. code-block:: shell - - docker run -it hello-world - -Deploy a vanilla GeoNode 2.10 with Docker -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Clone the Project - -.. code-block:: shell - - # Let's create the GeoNode core base folder and clone it - sudo mkdir -p /opt/geonode/ - sudo usermod -a -G www-data geonode - sudo chown -Rf geonode:www-data /opt/geonode/ - sudo chmod -Rf 775 /opt/geonode/ - - # Clone the GeoNode source code on /opt/geonode - cd /opt - git clone https://github.com/GeoNode/geonode.git geonode - -Start the Docker instances on ``localhost`` - -.. warning:: The first time pulling the images will take some time. You will need a good internet connection. - -.. code-block:: shell - - cd /opt/geonode - docker-compose -f docker-compose.yml -f docker-compose.override.localhost.yml pull - docker-compose -f docker-compose.yml -f docker-compose.override.localhost.yml up -d - -.. note:: If you want to re-build the docker images from scratch, instead of ``pulling`` them from the ``Docker Hub`` add the ``--build`` parameter to the up command, for instance: - - .. code-block:: shell - - docker-compose -f docker-compose.yml -f docker-compose.override.localhost.yml up --build - - In this case you can of course skip the ``pull`` step to download the ``pre-built`` images. - -.. note:: To startup the containers daemonized, which means they will be started in the background (and keep running if you ``log out`` from the server or close the ``shell``) add the ``-d`` option to the ``up`` command as in the following. ``docker-compose`` will take care to restart the containers if necessary (e.g. after boot). - - .. code-block:: shell - - docker-compose -f docker-compose.yml -f docker-compose.override.localhost.yml up -d - - # If you want to rebuild the images also - docker-compose -f docker-compose.yml -f docker-compose.override.localhost.yml up --build -d - -Test the instance and follow the logs -..................................... - -If you run the containers daemonized (with the ``-d`` option), you can either run specific Docker commands to follow the ``startup and initialization logs`` or entering the image ``shell`` and check for the ``GeoNode logs``. - -In order to follow the ``startup and initialization logs``, you will need to run the following command from the repository folder - -.. code-block:: shell - - cd /opt/geonode - docker logs -f django4geonode - -Alternatively: - -.. code-block:: shell - - cd /opt/geonode - docker-compose logs -f django - -You should be able to see several initialization messages. Once the container is up and running, you will see the following statements - -.. code-block:: shell - - ... - 789 static files copied to '/mnt/volumes/statics/static'. - static data refreshed - Executing UWSGI server uwsgi --ini /usr/src/app/uwsgi.ini for Production - [uWSGI] getting INI configuration from /usr/src/app/uwsgi.ini - -To exit just hit ``CTRL+C``. - -This message means that the GeoNode containers have bee started. Browsing to ``http://localhost/`` will show the GeoNode home page. You should be able to successfully log with the default admin user (``admin`` / ``admin``) and start using it right away. - -With Docker it is also possible to run a shell in the container and follow the logs exactly the same as you deployed it on a physical host. To achieve this run - -.. code-block:: shell - - docker exec -it django4geonode /bin/bash - - # Once logged in the GeoNode image, follow the logs by executing - tail -F -n 300 /var/log/geonode.log - -Alternatively: - -.. code-block:: shell - - docker-compose exec django /bin/bash - -To exit just hit ``CTRL+C`` and ``exit`` to return to the host. - -Override the ENV variables to deploy on a public IP or domain -............................................................. - -If you would like to start the containers on a ``public IP`` or ``domain``, let's say ``www.example.org``, you can - -.. code-block:: shell - - cd /opt/geonode - - # Stop the Containers (if running) - docker-compose stop - -Edit the ``ENV`` override file in order to deploy on ``www.example.org`` - -.. code-block:: shell - - # Make a copy of docker-compose.override.localhost.yml - cp docker-compose.override.localhost.yml docker-compose.override.example-org.yml - -Replace everywhere ``localhost`` with ``www.example.org`` - -.. code-block:: shell - - vim docker-compose.override.example-org.yml - -.. code-block:: shell - - # e.g.: :%s/localhost/www.example.org/g - - version: '2.2' - services: - - django: - build: . - # Loading the app is defined here to allow for - # autoreload on changes it is mounted on top of the - # old copy that docker added when creating the image - volumes: - - '.:/usr/src/app' - environment: - - DEBUG=False - - GEONODE_LB_HOST_IP=www.example.org - - GEONODE_LB_PORT=80 - - SITEURL=http://www.example.org/ - - ALLOWED_HOSTS=['www.example.org', ] - - GEOSERVER_PUBLIC_LOCATION=http://www.example.org/geoserver/ - - GEOSERVER_WEB_UI_LOCATION=http://www.example.org/geoserver/ - - celery: - build: . - volumes: - - '.:/usr/src/app' - environment: - - DEBUG=False - - GEONODE_LB_HOST_IP=www.example.org - - GEONODE_LB_PORT=80 - - SITEURL=http://www.example.org/ - - ALLOWED_HOSTS=['www.example.org', ] - - GEOSERVER_PUBLIC_LOCATION=http://www.example.org/geoserver/ - - GEOSERVER_WEB_UI_LOCATION=http://www.example.org/geoserver/ - - geoserver: - environment: - - GEONODE_LB_HOST_IP=www.example.org - - GEONODE_LB_PORT=80 - # - NGINX_BASE_URL= - -.. note:: It is possible to override here even more variables to customize the GeoNode instance. See the ``GeoNode Settings`` section in order to get a list of the available options. - -Run the containers in daemon mode - -.. code-block:: shell - - docker-compose -f docker-compose.yml -f docker-compose.override.example-org.yml up --build -d - -Access the django4geonode Docker container to update the code-base and/or change internal settings -.................................................................................................. - -Access the container ``bash`` - -.. code-block:: shell - - docker exec -i -t django4geonode /bin/bash - -You will be logged into the GeoNode instance as ``root``. The folder is ``/usr/src/app/`` where the GeoNode project is cloned. Here you will find the GeoNode source code as in the GitHub repository. - -.. note:: The machine is empty by default, no ``Ubuntu`` packages installed. If you need to install text editors or something you have to run the following commands: - - .. code-block:: shell - - apt update - apt install - - e.g.: - apt install vim - -Update the templates or the ``Django models``. Once in the ``bash`` you can edit the templates or the Django models/classes. From here you can run any standard ``Django management command``. - -Whenever you change a ``template/CSS/Javascript`` remember to run later: - -.. code-block:: shell - - python manage.py collectstatic - -in order to update the files into the ``statics`` Docker volume. - -.. warning:: This is an external volume, and a simple restart won't update it. You have to be careful and keep it aligned with your changes. - -Whenever you need to change some settings or environment variable, the easiest thing to do is to: - -.. code-block:: shell - - # Stop the container - docker-compose stop - - # Restart the container in Daemon mode - docker-compose -f docker-compose.yml -f docker-compose.override..yml up -d - -Whenever you change the model, remember to run later in the container via ``bash``: - -.. code-block:: shell - - python manage.py makemigrations - python manage.py migrate - -Access the geoserver4geonode Docker container to update the GeoServer version -............................................................................. - -This procedure allows you to access the GeoServer container. - -The concept is exactly the same as above, log into the container with ``bash``. - -.. code-block:: shell - - # Access the container bash - docker exec -it geoserver4geonode /bin/bash - -You will be logged into the GeoServer instance as ``root``. - -GeoServer is deployed on an Apache Tomcat instance which can be found here - -.. code-block:: shell - - cd /usr/local/tomcat/webapps/geoserver - -.. warning:: The GeoServer ``DATA_DIR`` is deployed on an external Docker Volume ``geonode_gsdatadir``. This data dir won’t be affected by changes to the GeoServer application since it is ``external``. - -Update the GeoServer instance inside the GeoServer Container - -.. warning:: The old configuration will be kept since it is ``external`` - -.. code-block:: shell - - docker exec -it geoserver4geonode bash - -.. code-block:: shell - - cd /usr/local/tomcat/ - wget --no-check-certificate https://build.geo-solutions.it/geonode/geoserver/latest/geoserver-.2.16.2.war - mkdir tmp/geoserver - cd tmp/geoserver/ - unzip /usr/local/tomcat/geoserver-2.16.2.war - rm -Rf data - cp -Rf /usr/local/tomcat/webapps/geoserver/data/ . - cd /usr/local/tomcat/ - mv webapps/geoserver/ . - mv tmp/geoserver/ webapps/ - exit - -.. code-block:: shell - - docker restart geoserver4geonode - -.. warning:: - - GeoNode 2.8.1 is **NOT** compatible with GeoServer > 2.13.x - - GeoNode 2.8.2 / 2.10.x are **NOT** compatible with GeoServer < 2.14.x - -Remove all data and bring your running GeoNode deployment to the initial stage -.............................................................................. - -This procedure allows you to stop all the containers and reset all the data with the deletion of all the volumes. - -.. code-block:: shell - - cd /opt/geonode - - # stop containers and remove volumes - docker-compose down -v - -Passages to completely get rid of old Docker images and volumes (reset the environment completely) -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. note:: For more details on Docker commands, please refer to the official Docker documentation. - -It is possible to let docker show which containers are currently running (add ``-a`` for all containers, also stopped ones) - -.. code-block:: shell - - # Show the currently running containers - docker ps - - CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES - 3b232931f820 geonode/nginx:production "nginx -g 'daemon of…" 26 minutes ago Up 26 minutes 0.0.0.0:80->80/tcp nginx4geonode - ff7002ae6e91 geonode/geonode:latest "/usr/src/app/entryp…" 26 minutes ago Up 26 minutes 8000/tcp django4geonode - 2f155e5043be geonode/geoserver:2.16.2 "/usr/local/tomcat/t…" 26 minutes ago Up 26 minutes 8080/tcp geoserver4geonode - 97f1668a01b1 geonode_celery "/usr/src/app/entryp…" 26 minutes ago Up 26 minutes 8000/tcp geonode_celery_1 - 1b623598b1bd geonode/postgis:10 "docker-entrypoint.s…" About an hour ago Up 26 minutes 5432/tcp db4geonode - - -Stop all the containers by running - -.. code-block:: shell - - docker-compose stop - -Force kill all containers by running - -.. code-block:: shell - - docker kill $(docker ps -q) - -I you want to clean up all containers and images, without deleting the static volumes (i.e. the ``DB`` and the ``GeoServer catalog``), issue the following commands - -.. code-block:: shell - - # Remove all containers - docker rm $(docker ps -a -q) - - # Remove all docker images - docker rmi $(docker images -q) - - # Prune the old images - docker system prune -a - -If you want to remove a ``volume`` also - -.. code-block:: shell - - # List of the running volumes - docker volume ls - - # Remove the GeoServer catalog by its name - docker volume rm -f geonode-gsdatadir - - # Remove all dangling docker volumes - docker volume rm $(docker volume ls -qf dangling=true) - - # update all images, should be run regularly to fetch published updates - for i in $(docker images| awk 'NR>1{print $1":"$2}'| grep -v ''); do docker pull "$i" ;done diff --git a/docs/install/index.rst b/docs/install/index.rst deleted file mode 100644 index 79ea3605283..00000000000 --- a/docs/install/index.rst +++ /dev/null @@ -1,15 +0,0 @@ - -.. toctree:: - :maxdepth: 3 - - core/index - -.. toctree:: - :maxdepth: 3 - - project/index - -.. toctree:: - :maxdepth: 3 - - spc/index diff --git a/docs/install/project/index.rst b/docs/install/project/index.rst deleted file mode 100644 index b12053f8ef2..00000000000 --- a/docs/install/project/index.rst +++ /dev/null @@ -1,507 +0,0 @@ -.. _geonode-project: - -=============== -GeoNode Project -=============== - -Overview -======== - -The following steps will guide you to a new setup of GeoNode Project. All guides will first install and configure the system to run it in ``DEBUG`` mode (also known as ``DEVELOPMENT`` mode) and then by configuring an HTTPD server to serve GeoNode through the standard ``HTTP`` (``80``) port. - -Those guides **are not** meant to be used on a production system. There will be dedicated chapters that will show you some *hints* to optimize GeoNode for a production-ready machine. In any case, we strongly suggest to task an experienced *DevOp* or *System Administrator* before exposing your server to the ``WEB``. - -Ubuntu 18.04 -============ - -This part of the documentation describes the complete setup process for GeoNode on an Ubuntu 18.04 64-bit clean environment (Desktop or Server). All examples use shell commands that you must enter on a local terminal or a remote shell. -- If you have a graphical desktop environment you can open the terminal application after login; -- if you are working on a remote server the provider or sysadmin should has given you access through an ssh client. - -.. _install_dep_proj: - -Install the dependencies -^^^^^^^^^^^^^^^^^^^^^^^^ - -In this section, we are going to install all the basic packages and tools needed for a complete GeoNode installation. To follow this guide, a piece of basic knowledge about Ubuntu Server configuration and working with a shell is required. This guide uses ``vim`` as the editor; fill free to use ``nano``, ``gedit`` or others. - -Upgrade system packages -....................... - -Check that your system is already up-to-date with the repository running the following commands: - -.. code-block:: shell - - sudo apt update - sudo apt upgrade - - -Create a Dedicated User -....................... - -In the following steps a User named ``geonode`` is used: to run installation commands the user must be in the ``sudo`` group. - -Create User ``geonode`` **if not present**: - -.. code-block:: shell - - # Follow the prompts to set the new user's information. - # It is fine to accept the defaults to leave all of this information blank. - sudo adduser geonode - - # The following command adds the user geonode to group sudo - sudo usermod -aG sudo geonode - - # make sure the newly created user is allowed to login by ssh - # (out of the scope of this documentation) and switch to User geonode - su geonode - -Packages Installation -..................... - -.. note:: You don't need to install the **system packages** if you want to run the project using Docker - -First, we are going to install all the **system packages** needed for the GeoNode setup. - -.. code-block:: shell - - # Install packages from GeoNode core - sudo apt install -y gdal-bin - sudo apt install -y python3-pip python3-dev python3-virtualenv python3-venv virtualenvwrapper - sudo apt install -y libxml2 libxml2-dev gettext - sudo apt install -y libxslt1-dev libjpeg-dev libpng-dev libpq-dev libgdal-dev libgdal20 - sudo apt install -y software-properties-common build-essential - sudo apt install -y git unzip gcc zlib1g-dev libgeos-dev libproj-dev - sudo apt install -y sqlite3 spatialite-bin libsqlite3-mod-spatialite - - # Install Openjdk - sudo -i apt update - sudo apt install openjdk-8-jdk-headless default-jdk-headless -y - sudo update-java-alternatives --jre-headless --jre --set java-1.8.0-openjdk-amd64 - - sudo apt update -y - sudo apt upgrade -y - sudo apt autoremove -y - sudo apt autoclean -y - sudo apt purge -y - sudo apt clean -y - - # Install Packages for Virtual environment management - sudo apt install -y virtualenv virtualenvwrapper - - # Install text editor - sudo apt install -y vim - -Geonode Project Installation -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Geonode project is the proper way to run a customized installation of Geonode. The repository of geonode-project contains a minimal set of files following the structure of a django-project. Geonode itself will be installed as a requirement of your project. -Inside the project structure is possible to extend, replace or modify all geonode componentse (e.g. css and other static files, templates, models..) and even register new django apps **without touching the original Geonode code**. - - -.. note:: You can call your geonode project whatever you like following the naming conventions for python packages (generally lower case with underscores (_). In the examples below, replace ``my_geonode`` with whatever you would like to name your project. - -See also the `README `_ file on geonode-project repository - -First of all we need to prepare a new Python Virtual Environment - -Prepare the environment - -.. code-block:: shell - - sudo mkdir -p /opt/geonode_custom/ - sudo usermod -a -G www-data geonode - sudo chown -Rf geonode:www-data /opt/geonode_custom/ - sudo chmod -Rf 775 /opt/geonode_custom/ - -Clone the source code - -.. code-block:: shell - - cd /opt/geonode_custom/ - git clone https://github.com/GeoNode/geonode-project.git - -Make an instance out of the ``Django Template`` - -.. note:: We will call our instance ``my_geonode``. You can change the name at your convenience. - -.. code-block:: shell - - vim ~/.bashrc - # add the following line to the bottom - source /usr/share/virtualenvwrapper/virtualenvwrapper.sh - -.. code-block:: shell - - source /usr/share/virtualenvwrapper/virtualenvwrapper.sh - mkvirtualenv --python=/usr/bin/python3 my_geonode - pip install Django==2.2.9 - - django-admin startproject --template=./geonode-project -e py,sh,md,rst,json,yml,ini,env,sample -n monitoring-cron -n Dockerfile my_geonode - - # Install the Python packages - cd /opt/geonode_custom/my_geonode - pip install -r requirements.txt --upgrade --no-cache --no-cache-dir - pip install -e . --upgrade - - # Install GDAL Utilities for Python - pip install pygdal=="`gdal-config --version`.*" - -Run GeoNode Project for the first time in DEBUG Mode -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. warning:: - - Be sure you have successfully completed all the steps of the section :ref:`install_dep_proj`. - -This command will run both GeoNode and GeoServer locally after having prepared the SQLite database. The server will start in ``DEBUG`` (or ``DEVELOPMENT``) mode, and it will start the following services: - -#. GeoNode on ``http://localhost:8000/`` -#. GeoServer on ``http://localhost:8080/geoserver/`` - -This modality is beneficial to debug issues and/or develop new features, but it cannot be used on a production system. - -.. code-block:: shell - - # Prepare the GeoNode SQLite database (the first time only) - paver setup - paver sync - -.. note:: - - In case you want to start again from a clean situation, just run - - .. code:: shell - - paver reset_hard - -.. warning:: This will blow up completely your ``local_settings``, delete the SQLlite database and remove the GeoServer data dir. - -.. code-block:: shell - - # Run the server in DEBUG mode - paver start - -Once the server has finished the initialization and prints on the console the sentence ``GeoNode is now available.``, you can open a browser and go to:: - - http://localhost:8000/ - -Sign-in with:: - - user: admin - password: admin - -From now on, everything already said for GeoNode Core (please refer to the section :ref:`configure_dbs_core` and following), applies to a -GeoNode Project. - -**Be careful** to use the **new** paths and names everywhere: - -* Everytime you'll find the keyword ``geonode``, you'll need to use your geonode custom name instead (in this example ``my_geonode``). - -* Everytime you'll find paths pointing to ``/opt/geonode/``, you'll need to update them to point to your custom project instead (in this example ``/opt/geonode_custom/my_geonode``). - -Docker -====== - -.. warning:: Before moving with this section, you should have read and clearly understood the ``INSTALLATION > GeoNode Core`` sections, and in particular the ``Docker`` one. Everything said for the GeoNode Core Vanilla applies here too, except that the Docker container names will be slightly different. As an instance if you named your project ``my_geonode``, your containers will be called: - - .. code-block:: shell - - 'django4my_geonode' instead of 'django4geonode' and so on... - -Deploy an instance of a geonode-project Django template 2.10.x with Docker on localhost -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Prepare the environment - -.. code-block:: shell - - sudo mkdir -p /opt/geonode_custom/ - sudo usermod -a -G www-data geonode - sudo chown -Rf geonode:www-data /opt/geonode_custom/ - sudo chmod -Rf 775 /opt/geonode_custom/ - -Clone the source code - -.. code-block:: shell - - cd /opt/geonode_custom/ - git clone https://github.com/GeoNode/geonode-project.git - -Make an instance out of the ``Django Template`` - -.. note:: We will call our instance ``my_geonode``. You can change the name at your convenience. - -.. code-block:: shell - - source /usr/share/virtualenvwrapper/virtualenvwrapper.sh - mkvirtualenv --python=/usr/bin/python3 my_geonode - pip install Django==2.2.9 - - django-admin startproject --template=./geonode-project -e py,sh,md,rst,json,yml,ini,env,sample -n monitoring-cron -n Dockerfile my_geonode - cd /opt/geonode_custom/my_geonode - -Modify the code and the templates and rebuild the Docker Containers - -.. code-block:: shell - - docker-compose -f docker-compose.yml build --no-cache - -Finally, run the containers - -.. code-block:: shell - - docker-compose -f docker-compose.yml up -d - -Deploy an instance of a geonode-project Django template 2.10.x with Docker on a domain -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. note:: We will use ``www.example.org`` as an example. You can change the name at your convenience. - -Stop the containers - -.. code-block:: shell - - cd /opt/geonode_custom/my_geonode - - docker-compose -f docker-compose.yml stop - -Edit the ``ENV`` override file in order to deploy on ``www.example.org`` - -Replace everywhere ``localhost`` with ``www.example.org`` - -.. code-block:: shell - - vim .env - -.. code-block:: shell - - # e.g.: :%s/localhost/www.example.org/g - -.. note:: It is possible to override here even more variables to customize the GeoNode instance. See the ``GeoNode Settings`` section in order to get a list of the available options. - -Run the containers in daemon mode - -.. code-block:: shell - - docker-compose -f docker-compose.yml -f docker-compose.override.example-org.yml up --build -d - -.. _install-with-ansible: - -Ansible -======= -`Ansible `__ is an open-source software provisioning, configuration management, and application-deployment tool for IT infrastructure. It is written in `Python `_ and -allows users to manage `nodes` (computers) over SSH. Configuration files are written in `YAML `_, a simple, human-readable, data serialization format. - -Ansible can be used for automating the manual installation process of GeoNode. In case you're new to GeoNode we suggest first to get an Overview of :doc:`/install/core/index` components. - - -Installing Ansible -^^^^^^^^^^^^^^^^^^ - -Before you install `Ansible` make sure you have Python 2 (version 2.7) or Python 3 (versions 3.5 and higher) -on the controlling machine, you will also need an SSH client. Most Linux distributions -come with an SSH client preinstalled. - -.. note:: For further installation instruction, please visit the `official installation documentation `_. - - -Test your Setup -^^^^^^^^^^^^^^^ - -After you've installed Ansible, you can test your setup by use of the following command - -.. code:: - - ansible localhost -m ping - -You should get the following output:: - - localhost | success >> { - "changed": false, - "ping": "pong" - } - -Ansible Hosts file -^^^^^^^^^^^^^^^^^^ - -Ansible keeps information about the managed nodes in the `inventory` or `hosts file`. -Edit or create the hosts file with your favorite editor:: - - vim /etc/ansible/hosts - -This file should contain a list of nodes for Ansible to manage. Nodes can be referred to -either with IP or hostname. The syntax is the following:: - - 192.168.1.50 - aserver.example.org - bserver.example.org - -For targeting several servers you can group them like:: - - mail.example.com - - [webservers] - foo.example.com - bar.example.com - - [dbservers] - one.example.com - two.example.com - three.example.com - - [geonode] - mygeonode.org - -Public Key access -^^^^^^^^^^^^^^^^^ - -To avoid having to type your user's password to connect to the nodes over and over, using -SSH keys is recommended. To setup Public Key SSH access to the nodes. First, create a key pair:: - - ssh-keygen - -And follow the instructions on the screen. A new key pair will be generated and -placed inside the `.ssh` folder in your user's home directory. - -All you need to do now is copy the public key (id_rsa.pub) into the `authorized_keys` -file on the node you want to manage, inside the user's home directory. For example, -if you want to be able to connect to mygeonode.org as user `geo` edit the -/home/geo/.ssh/authorized_keys file on the remote machine and add the content -of your public key inside the file. - -For more information on how to set up SSH keys in Ubuntu -refer to `this `_ document. - -Connect to managed nodes -^^^^^^^^^^^^^^^^^^^^^^^^ - -Now that SSH access to the managed nodes is in place for all the nodes inside the Ansible -`inventory` (hosts file), we can run our first command:: - - ansible geonode -m ping -u geo - -.. note:: - - change `geo` with the username to use for SSH login - -The output will be similar to this:: - - ansible all -m ping -u geo - 84.33.2.70 | success >> { - "changed": false, - "ping": "pong" - } - -We asked Ansible to connect to the machine in our `Inventory` grouped under `[geonode] as user `geo` -and run the `module` ping (modules are Ansible's units of work). -As you can see by the output, Ansible successfully connected to the remote machine -and executed the module `ping`. - -Ad hoc commands and playbooks -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Ansible integrates two basic concepts of running commands: -An ad-hoc command is something that you might type in to do something immediately, -but don’t want to save for later. One example of an ad-hoc command is the ping command we just ran. We typed in the -command line and ran it interactively. - -For more information on ad-hoc command refer to the `adhoc documentation section `_. - -Playbooks are Ansible’s configuration, deployment and orchestration language. -In contrast to ad hoc commands, Playbooks can declare configurations, but they can also orchestrate steps of any manual ordered process. - -For more information on playbooks refer to the `playbook documentation section `_. - -In the following, we will provide you an example on how to setup a playbook for installing GeoNode on a server. - - -Installing GeoNode project by use of a playbook -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -First, we have to install the underlying steps for installing geonode provided by the official GeoNode role:: - - $ ansible-galaxy install geonode.geonode - - -.. note:: Roles are ways of automatically loading certain vars_files, tasks, and handlers based on a known file structure. Grouping content by roles also allows easy sharing of roles with other users. - -See: https://docs.ansible.com/ansible/latest/user_guide/playbooks_reuse_roles.html - -To find out how these install tasks are defined, we suggest having a look a the `different tasks `_ of role geonode. - -Setup a playbook -^^^^^^^^^^^^^^^^ - -After installation of the role geonode.geonode we will now create a simple playbook which defines what should happen. -Create the playbook file where it suits best for you. For example in your home folder:: - - mkdir ~/geonode_ansible - vim ~/geonode_ansible/install_geonode.yml - -with following content - -.. code-block:: shell - - --- - - name: Provision a GeoNode into Production - hosts: geonode - remote_user: geo - vars: - app_name: my_geonode - server_name: 84.33.2.70 - deploy_user: ubuntu - code_repository: https://github.com/GeoNode/geonode-project.git - branch_name: master - virtualenv_dir: /home/geo/.venvs - site_url: http://mygeonode.org/ - geoserver_url: https://build.geo-solutions.it/geonode/geoserver/latest/geoserver-2.16.2.war - pg_max_connections: 100 - pg_shared_buffers: 128MB - tomcat_xms: 1024M - tomcat_xmx: 2048M - nginx_client_max_body_size: 400M - gather_facts: False - pre_tasks: - - name: Install python for Ansible - become: yes - become_user: root - raw: test -e /usr/bin/python || (apt -y update && apt install -y python3-minimal) - roles: - - { role: GeoNode.geonode } - - -The playbook is composed of different parts. The most important are: - -The **hosts part** specifies to which hosts in the Inventory this playbook applies and -how to connect to them. This points to your hosts file with grouped servers under `[geonode]` as -explained before. (Most likely you will only have one node under group geonode) - -The **vars** section mainly describe configured settings. Please visit the geonode ansible readme regarding `role variables `_. - -**Roles** points to our installed geonode role which has all needed installation tasks. - - - -Run the Playbook -^^^^^^^^^^^^^^^^ - -Now that we have created our Playbook, we can execute it with:: - - ansible-playbook ~/geonode_ansible/install_geonode.yml -u geo - - PLAY [84.33.2.70] ************************************************************* - - GATHERING FACTS *************************************************************** - ok: [84.33.2.70] - - ... - -Ansible should connect to the host specified in the hosts section grouped by `[geonode]` and run the install tasks one by one. If something goes wrong Ansible will fail fast and stop the installation process. -When successfully finished you should be able to see GeoNode's welcome screen at your `site_url`. - -This concludes our brief tutorial on Ansible. For a more thorough introduction -refer to the `official documentation `_. - -Also, take a look at the `Ansible examples repository `_ -or a set of Playbooks showing common techniques. diff --git a/docs/install/spc/index.rst b/docs/install/spc/index.rst deleted file mode 100644 index 3daee929747..00000000000 --- a/docs/install/spc/index.rst +++ /dev/null @@ -1,271 +0,0 @@ -========== -SPCGeoNode -========== - -Overview -======== - -SPCgeonode is a setup for Geonode deployment at SPC. It makes it easy to deploy a production ready Geonode. The setup aims for simplicity over flexibility, so that it will only apply for typical small scale Geonode installations. - -The setup is also usable for Geonode development or customization. - -Prerequisites -============= - -Make sure you have a version of Docker (tested with 17.12) and docker-compose. - -- Linux : https://docs.docker.com/install/linux/docker-ce/ubuntu/#install-from-a-package and https://docs.docker.com/compose/install/#install-compose -- Windows : https://store.docker.com/editions/community/docker-ce-desktop-windows -- Mac : https://store.docker.com/editions/community/docker-ce-desktop-mac - -Usage -===== - -All the following commands happen from this folder: - -.. code-block:: shell - - cd /path/to/geonode/scripts/spcgeonode - - -Development -^^^^^^^^^^^ - -To start only the main services (should be enough for development) : - -.. code-block:: shell - - docker-compose up --build -d django geoserver postgres nginx - - -To start the whole stack : - -.. code-block:: shell - - docker-compose up --build -d - -If not familiar with Docker, read below to know how to see what's happening. On first start, the containers will restart several times. Once everything started, you should be able to open http://127.0.0.1 in your browser. See how to edit the configuration below if you install on another computer. - -Production (using composer) -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Using a text editor, edit the `.env` file (you can also override those with environment variables) : - -.. code-block:: shell - - # General configuration - nano .env - - -When ready, start the stack using this commands: - -.. code-block:: shell - - # Run the stack - docker-compose -f docker-compose.yml up -d --build - - -Alternatively, you can pull the images from dockerhub instead of rebuilding (only applies if you haven't changed the docker setup): - -.. code-block:: shell - - # Pull the images and run the stack - docker-compose -f docker-compose.yml pull - docker-compose -f docker-compose.yml up -d - -If not familiar with Docker, read below to know how to see what's happening. On first start, the containers will restart several times. Once everything started, you should be able to open http://your_http_host or https://your_https_host in your browser. - -Upgrade -======= - -If at some point you want to update the SPCgeonode setup (this will work only if you didn't do modifications, if you did, you need to merge them): - -.. code-block:: shell - - # Get the update setup - git pull - -Upgrade the stack -^^^^^^^^^^^^^^^^^ - -.. code-block:: shell - - docker-compose -f docker-compose.yml up -d --build - -Development vs Production -========================= - -Difference of dev setup vs prod setup: - -- Django source is mounted on the host and uwsgi does live reload (so that edits to the python code is reloaded live) -- Django static and media folder, Geoserver's data folder and Certificates folder are mounted on the host (just to easily see what's happening) -- Django debug is set to True -- Postgres's port 5432 is exposed (to allow debugging using pgadmin) -- Nginx debug mode is activated (not really sure what this changes) -- Docker tags are set to dev instead of latest - -Releases -======== - -To make a release: - -- checkout spcgeonode-release -- merge spcgeonode -- replace the version tag in docker-compose.yml with the version (format `x.x.x`) -- commit -- create a git tag (format `spc/x.x.x`) -- push spcgeonode-release with tags - -This will trigger an automatic build on docker hub. - -If you need to manually publish the image (e.g. dockerhub build fail) : - -.. code-block:: shell - - docker login - docker-compose -f docker-compose.yml build - docker-compose -f docker-compose.yml push - -FAQ -=== - -Docker-primer - How to see what's happening? -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -If not familiar with Docker, here are some useful commands: - -- `docker ps`: list all containers and their status -- `docker-compose logs -f`: show live stdout from all containers -- `docker-compose logs -f django`: show live stdout from a specific container (replace `django` by `geoserver`, `postgres`, etc.) -- `docker-compose down -v`: brings the stack down including volumes, allowing you to restart from scratch **THIS WILL ERASE ALL DATA !!** - -During startup, a lot of container crash and restart, is it normal? -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -This is the normal startup process. Due to the nature of the setup, the containers are very interdepentent. Startup from scratch can take approx. 5-10 minutes, during which all containers may restart a lot of times. - -In short, Django will restart until Postgres is up so it can migrate the database. Geoserver will restart until Django has configured OAuth so it can get OAuth2 configuration. Django will restart until Geoserver is running so it can reinitialize the master password. - -Backups -^^^^^^^ - -*Backups* are made using [RClone](https://rclone.org/docs/). RClone is a flexible file syncing tool that supports all commons cloud provider, regular file transfer protocols as well as local filesystem. It should be able to accommodate almost any setup. - -The only available configuration provided with the setup assumes Amazon S3 is being used, in which case you need to replace the following parts of the `rclone.backup.config` file : `YOUR_S3_ACCESS_KEY_HERE`,`YOUR_S3_SECRET_KEY_HERE`,`YOUR_S3_REGION_HERE` and `THE_NAME_OF_YOUR_BUCKET_HERE` (watch [this](https://www.youtube.com/watch?v=BLTy2tQXQLY) to learn how to get these keys). - -Also consider enabling *versioning* on the Bucket, so that if data won't get lost if deleted accidentally in GeoNode. - -If you want to setup backups using another provider, check the [RClone documentation](https://rclone.org/docs/). It should be easy to add any RClone supported provider to SPCgeonode. - -How to migrate from an existing standard Geonode install -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -This section lists the steps done to migrate from an apt-get install of Geonode 2.4.1 (with Geoserver 2.7.4) to a fresh SPCGeonode 0.1 install. It is meant as a guide only as some steps may need some tweaking depending on your installation. Do not follow these steps if you don't understand what you're doing. - -Prerequisites -............. - -- access to the original server -- a new server for the install (can be the same than the first one if you don’t fear losing all data) - ideally linux but should be OK as long as it runs docker (64bits) -- an external hard-drive to copy data over - -On the old server -................. - -.. code-block:: shell - - # Move to the external hard drive - cd /path/to/your/external/drive - -#. Find the current database password (look for DATABASE_PASSWORD, in my case it was XbFAyE4w) - - .. code-block:: shell - - more /etc/geonode/local_settings.py - -#. Dump the database content (you will be prompted several time for the password above) - - .. code-block:: shell - - pg_dumpall --host=127.0.0.1 --username=geonode --file=pg_dumpall.custom - -#. Copy all uploaded files - - .. code-block:: shell - - cp -r /var/www/geonode/uploaded uploaded - -#. Copy geoserver data directory - - .. code-block:: shell - - cp -r /usr/share/geoserver/data geodatadir - -On the new server -................. - -Setup SPCGeonode by following the prerequisite and production steps on https://github.com/GeoNode/geonode/tree/master/scripts/spcgeonode up to (but not including) run the stack. - -Then run these commands: - -.. code-block:: shell - - # Prepare the stack (without running) - docker-compose -f docker-compose.yml pull --no-parallel - docker-compose -f docker-compose.yml up --no-start - - # Start the database - docker-compose -f docker-compose.yml up -d postgres - - # Initialize geoserver (to create the geodatadir) - docker-compose -f docker-compose.yml run --rm geoserver true - - # Go to the external drive - cd /path/to/drive/ - - # Restore the dump (this can take a while if you have data in postgres) - cat pg_dumpall.custom | docker exec -i spcgeonode_postgres_1 psql -U postgres - # Rename the database to postgres - docker exec -i spcgeonode_postgres_1 dropdb -U postgres postgres - docker exec -i spcgeonode_postgres_1 psql -d template1 -U postgres -c "ALTER DATABASE geonode RENAME TO postgres;" - - # Restore the django uploaded files - docker cp uploaded/. spcgeonode_django_1:/spcgeonode-media/ - - # Restore the workspaces and styles of the geoserver data directory - docker cp geodatadir/styles/. spcgeonode_geoserver_1:/spcgeonode-geodatadir/styles - docker cp geodatadir/workspaces/. spcgeonode_geoserver_1:/spcgeonode-geodatadir/workspaces - docker cp geodatadir/data/. spcgeonode_geoserver_1:/spcgeonode-geodatadir/data - - # Back to SPCgeonode - cd /path/to/SPCgeonode - - # Fix some inconsistency that prevents migrations (public.layers_layer shouldn’t have service_id column) - docker exec -i spcgeonode_postgres_1 psql -U postgres -c "ALTER TABLE public.layers_layer DROP COLUMN service_id;" - - # Migrate with fake initial - docker-compose -f docker-compose.yml run --rm --entrypoint "python manage.py migrate --fake-initial" django - - # Create the SQL diff to fix the schema # TODO : upstream some changes to django-extensions for this to work directly - docker-compose -f docker-compose.yml run --rm --entrypoint '/bin/sh -c "DJANGO_COLORS=nocolor python manage.py sqldiff -ae"' django >> fix.sql - - # Manually fix the SQL command until it runs (you can also drop the tables that have no model) - nano fix.sql - - # Apply the SQL diff (review the sql file first as this may delete some important tables) - cat fix.sql | docker exec -i spcgeonode_postgres_1 psql -U postgres - - # Set all layers as approved - docker exec -i spcgeonode_postgres_1 psql -U postgres -c 'UPDATE base_resourcebase SET is_approved = TRUE;' - - # This time start the stack - docker-compose -f docker-compose.yml up -d - -One last step was to connect to the GeoServer administration and change the PostGIS store host, user and password to 'postgres'. - -On windows, I have error like `standard_init_linux.go:190: exec user process caused "no such file or directory"` -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -This may be due to line endings. When checking out files, git optionally converts line endings to match the platform, which doesn't work well it `.sh` files. - -To fix, use `git config --global core.autocrlf false` and checkout again. diff --git a/docs/intermediate/backup/index.rst b/docs/intermediate/backup/index.rst deleted file mode 100644 index 072b97e3ee6..00000000000 --- a/docs/intermediate/backup/index.rst +++ /dev/null @@ -1,5 +0,0 @@ -GeoNode Full Backup and Restore -=============================== - -GeoNode selectively Export/Import Layers -======================================== diff --git a/docs/intermediate/index.rst b/docs/intermediate/index.rst deleted file mode 100644 index 8425b1be7db..00000000000 --- a/docs/intermediate/index.rst +++ /dev/null @@ -1,28 +0,0 @@ -.. _geonode_monitoring: - -Monitoring -========== - -.. toctree:: - :maxdepth: 3 - - monitoring/index - -GeoNode Backup and Restore -========================== - -.. toctree:: - :caption: GeoNode Backup and Restore - :maxdepth: 3 - - backup/index - - -Viewer and Hooksets -=================== - -.. toctree:: - :caption: Viewer and Hooksets - :maxdepth: 3 - - viewer/index \ No newline at end of file diff --git a/docs/intermediate/monitoring/api/index.rst b/docs/intermediate/monitoring/api/index.rst deleted file mode 100644 index cffd1f88c1e..00000000000 --- a/docs/intermediate/monitoring/api/index.rst +++ /dev/null @@ -1,1121 +0,0 @@ -Monitoring: API -=============== - -Overview --------- - -Geonode monitoring is an optional infrastructure for monitoring resource usage in GeoNode, accompanying GeoServer(s) and hosts on which each service is running. This is not full-fledge monitoring, like zabbix or nagios, rather a moderate size tool to diagnose deployment health. -It will be used by users that mostly are not full-time sysops, so usage is simplified. - -API ---- - -Monitoring API exposes various data to monitoring client. - -API root URL is ``/monitoring/``, each path in this documentation is relative to that root. - -Valid from/valid to -~~~~~~~~~~~~~~~~~~~ - -Monitoring collects data periodically, in fixed periods (usually 1 minute). -Each metric data is a value (or values if they are split by additional indicators, like resource, label etc) accumulated within that period. - -.. _host: - -Host -~~~~ - -Host is a physical or virtualized instance, on which specific service (GeoNode or GeoServer) is running. -This entity is not monitored, but it's used to group services by their deployment location. -Hosts list is available in API in ``/api/hosts/`` endpoint: - -``GET /monitoring/api/hosts/`` - -.. code-block:: json - - { - "hosts": [ - { - "ip": "127.0.0.1", - "name": "localhost" - } - ] - } - -While host is not monitored directly, some service types (and services of those types) are responsible for monitoring underlying host,hardware resources are monitored indirectly (no dedicated system-level agent is needed). - -Service -~~~~~~~ - -Service is a name of monitored service. -Services are configurable from admin interface, and exposed in API in ``/api/services/``: - -``GET /monitoring/api/services/`` - -.. code-block:: json - - { - "services": [ - { - "name": "local-system", - "last_check": "2017-08-03T13:33:26.674", - "host": "localhost", - "check_interval": 60, - "type": "hostgeonode", - "id": 3 - }, - { - "name": "local-geoserver", - "last_check": "2017-08-03T13:33:26.455", - "host": "localhost", - "check_interval": 60, - "type": "geoserver", - "id": 2 - }, - { - "name": "local-geonode", - "last_check": "2017-08-03T13:33:27.741", - "host": "localhost", - "check_interval": 60, - "type": "geonode", - "id": 1 - } - ] - } - -Each service is described by properties: - -* `name` - unique name of service -* `type` - service type name -* `host` - host on which service is running -* `id` - object id -* `last_check` - timestamp with last check (data collection) on that service -* `check_interval` - interval in seconds, how often data should be collected from this service. - -Service type -~~~~~~~~~~~~ - -Service type describes kind of services to which it's assigned. There are several service types available: - -* `geonode` - service is a GeoNode instance -* `geoserver` - service is a GeoServer instance -* `hostgeonode` - service is not an application, service is underlying host measured with GeoNode (see :ref:`host`) -* `hostserver` - service is not an application, service is underlying host measured with GeoServer (see :ref:`host`) - -Resource -~~~~~~~~ - -Resource is an object that can be served by GeoNode or GeoServer. There are several resource types monitored: - -* layer -* document -* map -* url - -Resource can be served from either GeoNode or GeoServer. -We don't check if specific resource actually exists, just keep list of items used and recorded for monitoring. -Also, it won't show renames/copies/moves of the same resource. - -Resources list is available in ``/api/resources/`` endpoint: - -``GET /monitoring/api/resources/`` - -.. code-block:: json - - { - "resources": [ - { - "type": "layer", - "id": 13, - "name": "unesco:Unesco_point" - }, - { - "type": "layer", - "id": 7, - "name": "geonode:test" - }, - { - "type": "layer", - "id": 14, - "name": "http://www.opengis.net/gml:GridCoverage" - }, - { - "type": "map", - "id": 17, - "name": "some map" - }, - ] - } - -Resource is described with following attributes: - -* `id` - numeric id of resource record in monitoring -* `type` - type of resource -* `name` - name of resource. - -Resources list can be filtered with following query sting arguments: - -* `metric_name` - name of metric for which resources should be returned -* `resource_type` - name of type of resource (`layer`, `map`, `document`, `style`, `url`) -* `valid_from` - list resources that are available since that timestamp -* `valid_to` - list resources that are available until that timestamp - -Example: - -``GET /monitoring/api/resources/?resource_type=layer&metric_name=request.count&valid_from=2017-08-01`` - -.. code-block:: json - - { - "resources": [ - { - "type": "layer", - "id": 24, - "name": "atlantis:landmarks" - }, - { - "type": "layer", - "id": 2, - "name": "topp:states" - }, - { - "type": "layer", - "id": 22, - "name": "atlantis:island" - }, - { - "type": "layer", - "id": 23, - "name": "atlantis:poi" - }, - { - "type": "layer", - "id": 16, - "name": "dissolveroad2" - }, - { - "type": "layer", - "id": 21, - "name": "atlantis:roads" - } - ] - } - -Resource type -~~~~~~~~~~~~~ - -Resource Types describe which types of resource the GeoNode monitoring consider. -To retrieve the full list of Resource Types the ``/api/resource_types/`` is available: - -``GET /monitoring/api/resource_types/`` - -.. code-block:: json - - { - "status": "ok", - "data": { - "key": "resource_types" - }, - "errors": {}, - "resource_types": [ - { - "type": "No resource", - "name": "" - }, - { - "type": "Layer", - "name": "layer" - }, - { - "type": "Map", - "name": "map" - }, - { - "type": "Resource base", - "name": "resource_base" - }, - { - "type": "Document", - "name": "document" - }, - { - "type": "Style", - "name": "style" - }, - { - "type": "Admin", - "name": "admin" - }, - { - "type": "URL", - "name": "url" - }, - { - "type": "Other", - "name": "other" - } - ], - "success": true - } - -Event Types -~~~~~~~~~~~ - -Event Types describe the way resources were used in GeoNode. -Resource can be accessed as a regular view (throuhg GeoNode, like `/layers/X` url), or through OWS request. -Full list of Event Types handled is available in ``/api/event_types/`` endpoint: - -``GET /monitoring/api/event_types/`` - -.. code-block:: json - - { - "status": "ok", - "errors": { }, - "data": { - "key": "event_types" - }, - "event_types": [ - { - "name": "all" - }, - { - "name": "other" - }, - { - "name": "download" - }, - { - "name": "view" - }, - { - "name": "OWS:TMS" - }, - { - "name": "OWS:WMS-C" - }, - { - "name": "OWS:WMTS" - }, - { - "name": "OWS:WCS" - }, - { - "name": "OWS:WFS" - }, - { - "name": "OWS:WMS" - }, - { - "name": "OWS:WPS" - }, - { - "name": "OWS:ALL" - }, - { - "name": "create" - }, - { - "name": "upload" - }, - { - "name": "change" - }, - { - "name": "change_metadata" - }, - { - "name": "view_metadata" - }, - { - "name": "publish" - }, - { - "name": "remove" - } - ], - "success": true - } - -Event types starting with `OWS:` prefix mean they're related to OWS service. -`OWS:ALL` is a cumulative event type, which keeps requests for any OWS. - -Event type `other` means request not related to OWS. -This is also cumulative event type, and should be used as a baseline of all non-ows requests. - -In order to retrieve `OWS` only requests the `ows-service` *flag* (possible values are `True`, `true`, `False`, `false`, `0`, `1`) can be used: - -* `OWS` event types - - ``GET /monitoring/api/event_types/?ows_service=true`` - - .. code-block:: json - - { - "status": "ok", - "errors": {}, - "data": { - "key": "event_types" - }, - "event_types": [ - { - "name": "OWS:TMS", - "type_label": "TMS" - }, - { - "name": "OWS:WMS-C", - "type_label": "WMS-C" - }, - { - "name": "OWS:WMTS", - "type_label": "WMTS" - }, - { - "name": "OWS:WCS", - "type_label": "WCS" - }, - { - "name": "OWS:WFS", - "type_label": "WFS" - }, - { - "name": "OWS:WMS", - "type_label": "WMS" - }, - { - "name": "OWS:WPS", - "type_label": "WPS" - }, - { - "name": "OWS:ALL", - "type_label": "Any OWS" - } - ], - "success": true - } - -* `non-OWS` event types - - ``GET /monitoring/api/event_types/?ows_service=false`` - - .. code-block:: json - - { - "status": "ok", - "errors": {}, - "data": { - "key": "event_types" - }, - "event_types": [ - { - "name": "other", - "type_label": "Not OWS" - }, - { - "name": "all", - "type_label": "All" - }, - { - "name": "create", - "type_label": "Create" - }, - { - "name": "upload", - "type_label": "Upload" - }, - { - "name": "change", - "type_label": "Change" - }, - { - "name": "change_metadata", - "type_label": "Change Metadata" - }, - { - "name": "view_metadata", - "type_label": "View Metadata" - }, - { - "name": "view", - "type_label": "View" - }, - { - "name": "download", - "type_label": "Download" - }, - { - "name": "publish", - "type_label": "Publish" - }, - { - "name": "remove", - "type_label": "Remove" - }, - { - "name": "geoserver", - "type_label": "Geoserver event" - } - ], - "success": true - } - -Event type `all` means any request. - -Label -~~~~~ - -Label is a description of subset of metric data that is not described by resources (it's not served as logical data set). -Things that can be described with label: - -* user tracking id -* volume mount point -* network interface name -* request path -* request method -* response status code -* etc ... - - List of all labels recorded is available in ``/api/labels/`` endpoint: - -``GET /monitoring/api/labels/`` - -.. code-block:: json - - { - "labels": [ - { - "id": 306, - "name": "Other / Other / Python Requests 2.13" - }, - { - "id": 315, - "name": "Kent" - }, - { - "id": 298, - "name": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/59.0.3071.115 Safari/537.36" - }, - { - "id": 261, - "name": "lo" - }, - { - "id": 331, - "name": "PUT" - }, - { - "id": 334, - "name": "Other / Other / Python Requests 2.18" - } - ] - } - -Each metric data set will have at least one label attached. List of labels can be filtered with following query sting arguments: - -* `metric_name` - name of metric for which labels should be returned -* `valid_from` - list labels that are available since that timestamp -* `valid_to` - list labels that are available until that timestamp - -Example: - -``GET /monitoring/api/labels/?metric_name=request.ua&valid_from=2017-08-05`` - -.. code-block:: json - - { - "labels": [ - { - "id": 298, - "name": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/59.0.3071.115 Safari/537.36" - }, - { - "id": 312, - "name": "Java/1.8.0_131" - }, - { - "id": 293, - "name": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/36.0.1985.67 Safari/537.36" - }, - { - "id": 345, - "name": "Mozilla/5.0 (Macintosh; Intel Mac OS X) AppleWebKit/538.1 (KHTML, like Gecko) PhantomJS/2.1.1 Safari/538.1" - }, - ... - ] - } - -Metric name -~~~~~~~~~~~ - -Metric name is a semi-namespace description of what kind of data metric stores. -Typical metric names: -- `request.count` -- `request.ip` -- `response.size` -- `response.status` - -Each service type has a set of metrics available. -Application-level services will have different metric set than host-level services. - -Full list of metrics is available in ``/api/metrics/`` endpoint. Returned list is not filterable. -Sample response: - -``GET /monitoring/api/metrics/`` - -.. code-block:: json - - { - "metrics": [ - { - "metrics": [ - { - "type": "count", - "name": "request.count", - "unit": "Count" - }, - { - "type": "count", - "name": "request.ip", - "unit": "Count" - }, - ... - ], - "service": "geonode" - }, - { "service": "geoserver", - "metrics": [..] - } - ] - } - -Metrics are grouped by service. Each metric has following structure: - -.. code-block:: json - - { - "type": "count", - "name": "request.ip", - "unit": "Count" - } - -where: - -* `type` is a metric data type (it can be count, value or rate). This is internal description of how to deal with aggregation of data for metric. -* `name` name of metric -* `unit` suggested Y-axis label, describing data units - -Metric Data -~~~~~~~~~~~ - -Core feature of monitoring API is ability to get data for given metric for specified period. -Metric value is a data set for fixed period of time, from which data were collected and processed for one specific metric name. -Additionally, each metric can have data calculated for specific services, resources, labels and event_types. -Metric data API has several features: - -* it can show metric data within specific time frame, down to 1 minute granularity (may be less if collection intervals are lower). -* it can show metric data aggregated with custom granularity (for example from last 48 hours with 15 minutes granularity). -* it can show metric data for whole monitored setup or for specific resource, label (like user agent type), monitored service (just for geonode or just for geoserver), Event type. Params can be joined in one query. - -API endpoint is: ``/api/metric_data/METRIC_NAME/``: - -Sample request for `request.ua` metric in specific time window (between 10am and 2pm of 2017-08-03) and data granularity (1h) - -| ``GET /monitoring/api/metric_data/request.ua/?`` -| ``valid_from=2017-08-03%2010:00:00&valid_to=2017-08-03%2014:00:00&interval=3600`` - -.. code-block:: json - - { - "data": { - "input_valid_from": "2017-08-03T10:00:00", - "input_valid_to": "2017-08-03T14:00:00", - "data": [ - { - "valid_from": "2017-08-03T10:00:00", - "data": [], - "valid_to": "2017-08-03T11:00:00" - }, - { - "valid_from": "2017-08-03T11:00:00", - "data": [ - { - "samples_count": 10, - "val": "10.0000", - "min": "1.0000", - "max": "1.0000", - "sum": "10.0000", - "label": "Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:53.0) Gecko/20100101 Firefox/53.0", - "metric_count": 10 - }, - { - "samples_count": 790, - "val": "790.0000", - "min": "19.0000", - "max": "79.0000", - "sum": "790.0000", - "label": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/60.0.3112.78 Safari/537.36", - "metric_count": 22 - }, - { - "samples_count": 150, - "val": "150.0000", - "min": "15.0000", - "max": "15.0000", - "sum": "150.0000", - "label": "Mozilla/5.0 (Macintosh; Intel Mac OS X) AppleWebKit/538.1 (KHTML, like Gecko) PhantomJS/2.1.1 Safari/538.1", - "metric_count": 10 - } - ], - "valid_to": "2017-08-03T12:00:00" - }, - { - "valid_from": "2017-08-03T12:00:00", - "data": [], - "valid_to": "2017-08-03T13:00:00" - }, - { - "valid_from": "2017-08-03T13:00:00", - "data": [ - { - "samples_count": 37, - "val": "37.0000", - "min": "4.0000", - "max": "12.0000", - "sum": "37.0000", - "label": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/60.0.3112.40 Safari/537.36", - "metric_count": 4 - } - ], - "valid_to": "2017-08-03T14:00:00" - } - ], - "metric": "request.ua", - "interval": 3600, - "type": "count", - "axis_label": "Count", - "label": null - } - } - -Metric data response is wrapped with following envelope: - -.. code-block:: json - - "data": { - "input_valid_from": "2017-08-03T10:00:00", - "input_valid_to": "2017-08-03T14:00:00", - "metric": "request.ua", - "interval": 3600, - "type": "count", - "axis_label": "Count", - "label": null, - "data": [ - ... # actual data - ], - } - } - -where: - -* `input_valid_from` and `input_valid_to` are parsed and aligned timestamps for which data are returned, -* `metric` is metric name for which response is returned, -* `interval` data aggregation interval used, in seconds (if none is provided, 60 seconds are used, unless time window is larger than 24 hours), -* `type` is metric data type, which describes internally how data are aggregated (sum, average or min/max function). -* `axis_label` is suggested value-axis label to be used in chart -* `label` is metric data label used (no label by default). - -Metric data item is build as following structure: - -.. code-block:: json - - { - "valid_from": "2017-08-03T13:00:00", - "valid_to": "2017-08-03T14:00:00", - "data": [ - { - "samples_count": 37, - "val": "37.0000", - "min": "4.0000", - "max": "12.0000", - "sum": "37.0000", - "label": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/60.0.3112.40 Safari/537.36", - "metric_count": 4 - }, - { - "samples_count": 20, - "val": "20.0000", - "min": "4.0000", - "max": "10.0000", - "sum": "20.0000", - "label": "Internet Explorer 4.0", - "metric_count": 3 - }, - ], - - } - -where: - -* `valid_from` and `valid_to` are timestamps of data aggregation period -* `data` is a list of value rows. When `data` is empty, that means no data were collected for input params. -* each `data` element contains: - - - `label` label value associated with metric data value. This can describe user-provided differentiation value (user agent string, request method etc), or, if such value is not in use, default, "count" or "value" label. - - `val` is metrid data aggregated value, which should be used by frontend application. For `request.ua` this means count of requests for given user agent string, for `response.time` that will return average response time. - - `min`, `max`, `sum` are helper statistical values to give insight on data used, - - `samples_count` is a sum of all samples counts (actual requests) used for this calculation - - `metric_count` is a number of metric data used to calculate the value. - - `resource` (optional) key with resource structure (`id`, `name`, `type`). This element will be visible when grouping by resource is used. - - `event_type` (optional) key with name of event type related to rest of row. This element will be visible when grouping by event type is used - -Metric data can be filtered with following params: - -* `valid_from` timestamp (date or date + time) meaning that data should be newer than this timestamp -* `valid_to` timestamp (date or date + time) meaning that data should be older than this timestamp -* `interval` data aggregation interval, in seconds. See below notes about intervals and timestamps alignment -* `label` label value only for which data should be returned (see [Labels](#labels)) -* `resource` id of resource (see [Resources](#resources)) for which data should be returned -* `service` name of service (see [Services](#services)) for which data should be returned -* `event_type` name of service (see [Event Types](#ows_service)) for which data should be returned -* `resource_type` name of resource type to filter by, for example `layer` to show only data for layer objects (exclude urls, documents, maps). - -grouping metric data -~~~~~~~~~~~~~~~~~~~~ - -Additionally, in some cases client application may want to receive list of data points in one period for several resources (typical usage scenario: list top-most requested layers). -In such case, metric data should be queried also with following params: - -* `group_by` - name of object which should be used for grouping. At the moment two grouping modes are available: - - - `resource` - group by resource affected. This will produce metrics for the same label but each resource affected will be listed separately. Returned metric data items will have additional `resource` key, which will hold dictionary with keys `name` and `type`. Sample response: - - ``GET /monitoring/api/metric_data/request.count/?last=86400&interval=86400&group_by=resource`` - - .. code-block:: json - - { - "data": { - "input_valid_from": "2017-09-01T00:00:00", - "input_valid_to": "2017-09-08T13:50:34.024", - "data": [ - .. - { - "valid_from": "2017-09-04T00:00:00", - "data": [ - { - "resource": { - "type": "layer", - "name": "nurc:Arc_Sample" - }, - "samples_count": 300, - "val": "300.0000", - "min": "100.0000", - "max": "100.0000", - "sum": "300.0000", - "label": "count", - "metric_count": 3, - "id": 10 - }, - { - "resource": { - "type": "layer", - "name": "sde:HYP_HR_SR_OB_DR" - }, - "samples_count": 72, - "val": "72.0000", - "min": "24.0000", - "max": "24.0000", - "sum": "72.0000", - "label": "count", - "metric_count": 3, - "id": 25 - } - ], - "valid_to": "2017-09-05T00:00:00" - } - ], - "valid_to": "2017-09-09T00:00:00" - } - ], - "metric": "request.count", - "interval": 86400, - "type": "count", - "axis_label": "Count", - "label": null - } - } - - - `resource_no_labels` - group by resource affected, but do not distinct by label. This will produce similar result as the other grouping, but it will not contain 'label' key. - - ``GET /monitoring/api/metric_data/request.users/?`` - ``last=86400&interval=86400&group_by=resource_no_label&event_type=view&resource_type=url`` - - .. code-block:: json - - { - "data": { - "input_valid_from": "2018-07-10T15:13:50.784Z", - "input_valid_to": "2018-07-11T15:13:50.784Z", - "data": [ - { - "val"id_from: "2018-07-10T15:13:50.784Z", - "data": [ - { - "resource": { - "type": "url", - "name": "/layers/", - "id": 15 - }, - "metric_count": 4, - "val": 2, - "min": "1.0000", - "max": "1.0000", - "sum": "4.0000", - "samples_count": 4 - }, - { - "resource": { - "type": "url", - "name": "/", - "id": 16 - }, - "metric_count": 4, - "val": 2, - "min": "1.0000", - "max": "4.0000", - "sum": "7.0000", - "samples_count": 7 - }, - { - "resource": { - "type": "url", - "name": "/maps/", - "id": 17 - }, - "metric_count": 4, - "val": 2, - "min": "1.0000", - "max": "2.0000", - "sum": "5.0000", - "samples_count": 5 - }, - { - "resource": { - "type": "url", - "name": "/maps/3", - "id": 18 - }, - "metric_count": 1, - "val": 1, - "min": "1.0000", - "max": "1.0000", - "sum": "1.0000", - "samples_count": 1 - }, - { - "resource": { - "type": "url", - "name": "/maps/7", - "id": 20 - }, - "metric_count": 1, - "val": 1, - "min": "1.0000", - "max": "1.0000", - "sum": "1.0000", - "samples_count": 1 - } - ], - "valid_to": "2018-07-11T15:13:50.784Z" - } - ], - "metric": "request.users", - "interval": 86400, - "type": "value", - "axis_label": "Count", - "label": null - } - } - - - `label` - group by label. This will return number of unique label occurrences within selected period. - - ``GET /monitoring/api/metric_data/request.users/?last=86400&interval=86400&group_by=label`` - - .. code-block:: json - - { - "data": { - "input_valid_from": "2018-07-10T16:29:08.982Z", - "input_valid_to": "2018-07-11T16:29:08.982Z", - "data": [ - { - "valid_from": "2018-07-10T16:29:08.982Z", - "data": [ - { - "samples_count": 243, - "val": 13, - "min": "0.0000", - "max": "25.0000", - "sum": "243.0000", - "metric_count": 124 - } - ], - "valid_to": "2018-07-11T16:29:08.982Z" - } - ], - "metric": "request.users", - "interval": 86400.0, - "type": "value", - "axis_label": "Count", - "label": null - } - } - - - `event_type` - group by event type. This will expose `event_type` field in data items. Grouping will return number of requests per each event type. - - `event_type_on_label` - group by event type but use label to do grouping (instead of metric data value). This will expose `event_type` field in data items. Grouping will return number of requests per label (especially for `request.users`, which uses label field as tracking id value, see [User Analytics](https://github.com/geosolutions-it/geonode/wiki/Monitoring:-User-Analytics)). - -Timestamps alignment -~~~~~~~~~~~~~~~~~~~~ - -Data collected by monitoring are aggregated into fixed period values. This have several consequences: - -* you cannot query for time window smaller than aggregation period -* when querying for time window, input valid_from and valid_to will be aligned to possible actual valid_from and valid_to values. Alignment is calculated from 0:00h each day. For best results, you should use intervals that can be aligned without reminders. -* timestamps alignment may produce more rows than you expect in some cases. For example, let's say client application want to have data aggregated with 5 minutes interval. Search for data between 12:04 and 12:06, even if interval between those two (2 minutes) is smaller than data interval (5 minutes), this will be aligned to data intervals, which will be: - - * from 12:00 to 12:05 - * from 12:05 to 12:10 - - If data aggregation period ends in the future, there's good chance it will not contain any data. - -Exceptions -~~~~~~~~~~ - -Exceptions are served with separate API endpoints. Those endpoints will return: - -* list of exceptions captured -* exception details - -List of exceptions is available in ``/api/exceptions/`` endpoint: - -``GET /monitoring/api/exceptions/`` - -.. code-block:: json - - { - "exceptions": [ - { - "url": "/monitoring/api/exceptions/8/", - "error_type": "exceptions.ValueError", - "id": 8, - "service": { - "type": "geonode", - "name": "local-geonode" - }, - "created": "2017-06-20T17:50:24.922" - }, - { - "url": "/monitoring/api/exceptions/9/", - "error_type": "org.geoserver.platform.ServiceException", - "id": 9, - "service": { - "type": "geoserver", - "name": "local-geoserver" - }, - "created": "2017-06-26T15:33:20.152" - }, - { - "url": "/monitoring/api/exceptions/10/", - "error_type": "django.db.utils.ProgrammingError", - "id": 10, - "service": { - "type": "geonode", - "name": "local-geonode" - }, - "created": "2017-06-27T12:32:37.032" - }, - ] - } - -Each exception in list contains: - -* `error_type` which is a class of exception -* `id` object id for given exception recorded -* ` service` service object, on which exception was recorded -* `created` exception recorded timestamp -* `url` url with exception details - -Exception details: - -``GET /monitoring/api/exceptions/30/`` - -.. code-block:: json - - { - "error_data": "Traceback (most recent call last):\n File \"/home/cezio/.virtualenvs/geonode/lib/python2.7/site-packages/django/core/handlers/base.py\", line 132, in get_response\n response = wrapped_callback(request, *callback_args, **callback_kwargs)\n File \"/home/cezio/.virtualenvs/geonode/lib/python2.7/site-packages/django/views/generic/base.py\", line 71, in view\n return self.dispatch(request, *args, **kwargs)\n File \"/home/cezio/.virtualenvs/geonode/lib/python2.7/site-packages/django/views/generic/base.py\", line 89, in dispatch\n return handler(request, *args, **kwargs)\n File \"/mnt/work/cezio/geosolutions/repos/geonode/geonode/contrib/monitoring/views.py\", line 176, in get\n return json_response({self.output_name: out})\n File \"/mnt/work/cezio/geosolutions/repos/geonode/geonode/utils.py\", line 619, in json_response\n body = json.dumps(body, cls=DjangoJSONEncoder)\n File \"/usr/lib64/python2.7/json/__init__.py\", line 251, in dumps\n sort_keys=sort_keys, **kw).encode(obj)\n File \"/usr/lib64/python2.7/json/encoder.py\", line 207, in encode\n chunks = self.iterencode(o, _one_shot=True)\n File \"/usr/lib64/python2.7/json/encoder.py\", line 270, in iterencode\n return _iterencode(o, 0)\n File \"/home/cezio/.virtualenvs/geonode/lib/python2.7/site-packages/django/core/serializers/json.py\", line 115, in default\n return super(DjangoJSONEncoder, self).default(o)\n File \"/usr/lib64/python2.7/json/encoder.py\", line 184, in default\n raise TypeError(repr(o) + \" is not JSON serializable\")\nTypeError: is not JSON serializable\n", - "service": { - "type": "geonode", - "name": "local-geonode" - }, - "created": "2017-07-24T13:29:28.321", - "error_type": "exceptions.TypeError", - "request": { - "event_type": null, - "client": { - "ip": "127.0.0.1", - "position": { - "lat": null, - "country": null, - "lon": null, - "city": null - }, - "user_agent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/60.0.3112.40 Safari/537.36", - "user_agent_family": "PC / Linux / Chrome 60.0.3112" - }, - "request": { - "path": "/monitoring/api/exceptions/", - "host": "localhost:8000", - "method": "GET", - "created": "2017-07-24T13:29:28.280" - }, - "response": { - "status": 200, - "time": 30, - "type": "text/html; charset=utf-8", - "size": 0 - }, - "resources": [] - }, - "error_message": "exceptions.TypeError" - } - -Details contain: - -* `error_type` which is a class of exception -* `error_message` message provided with error -* `error_data` is a plain text with stack trace -* `service` service object, on which exception was recorded -* `created` exception recorded timestamp -* `request` information on request associated with this error: - - * `event_type` name of Event Type associated with request - * `client` requesting client information - * `request` details on request received - * `response` details on response send back - * `resources` list of resources affected - -Autoconfiguration -~~~~~~~~~~~~~~~~~ - -Autoconfiguration endpoint allows to perform monitoring configuration based on `settings` values. -This API endpoint is available to superusers/staff only. Response is wrapped with standard envelope. - -``POST /monitoring/api/autoconfigure/`` - -.. code-block:: json - - { - "status": "ok", - "success": true, - "errors": {} - } diff --git a/docs/intermediate/monitoring/geonode_monitoring/img/admin-monitoring-add-host.png b/docs/intermediate/monitoring/geonode_monitoring/img/admin-monitoring-add-host.png deleted file mode 100644 index 13a9cb228d7..00000000000 Binary files a/docs/intermediate/monitoring/geonode_monitoring/img/admin-monitoring-add-host.png and /dev/null differ diff --git a/docs/intermediate/monitoring/geonode_monitoring/img/admin-monitoring-add-service.png b/docs/intermediate/monitoring/geonode_monitoring/img/admin-monitoring-add-service.png deleted file mode 100644 index 2bc14c3a6d3..00000000000 Binary files a/docs/intermediate/monitoring/geonode_monitoring/img/admin-monitoring-add-service.png and /dev/null differ diff --git a/docs/intermediate/monitoring/geonode_monitoring/img/admin-monitoring-host.png b/docs/intermediate/monitoring/geonode_monitoring/img/admin-monitoring-host.png deleted file mode 100644 index 202f4a62bfc..00000000000 Binary files a/docs/intermediate/monitoring/geonode_monitoring/img/admin-monitoring-host.png and /dev/null differ diff --git a/docs/intermediate/monitoring/geonode_monitoring/img/admin-monitoring-hosts-services-underline.png b/docs/intermediate/monitoring/geonode_monitoring/img/admin-monitoring-hosts-services-underline.png deleted file mode 100644 index 92cb580d012..00000000000 Binary files a/docs/intermediate/monitoring/geonode_monitoring/img/admin-monitoring-hosts-services-underline.png and /dev/null differ diff --git a/docs/intermediate/monitoring/geonode_monitoring/img/admin-monitoring-section-standalone.png b/docs/intermediate/monitoring/geonode_monitoring/img/admin-monitoring-section-standalone.png deleted file mode 100644 index dd60a6bff03..00000000000 Binary files a/docs/intermediate/monitoring/geonode_monitoring/img/admin-monitoring-section-standalone.png and /dev/null differ diff --git a/docs/intermediate/monitoring/geonode_monitoring/img/admin-monitoring-section.png b/docs/intermediate/monitoring/geonode_monitoring/img/admin-monitoring-section.png deleted file mode 100644 index 2deb0f27cb4..00000000000 Binary files a/docs/intermediate/monitoring/geonode_monitoring/img/admin-monitoring-section.png and /dev/null differ diff --git a/docs/intermediate/monitoring/geonode_monitoring/img/admin-monitoring-service-local-geonode.png b/docs/intermediate/monitoring/geonode_monitoring/img/admin-monitoring-service-local-geonode.png deleted file mode 100644 index 9586eed93bb..00000000000 Binary files a/docs/intermediate/monitoring/geonode_monitoring/img/admin-monitoring-service-local-geonode.png and /dev/null differ diff --git a/docs/intermediate/monitoring/geonode_monitoring/img/admin-monitoring-service-local-geoserver.png b/docs/intermediate/monitoring/geonode_monitoring/img/admin-monitoring-service-local-geoserver.png deleted file mode 100644 index f68219a8c35..00000000000 Binary files a/docs/intermediate/monitoring/geonode_monitoring/img/admin-monitoring-service-local-geoserver.png and /dev/null differ diff --git a/docs/intermediate/monitoring/geonode_monitoring/img/admin-monitoring-service-local-system-geonode.png b/docs/intermediate/monitoring/geonode_monitoring/img/admin-monitoring-service-local-system-geonode.png deleted file mode 100644 index b74f27f9c9b..00000000000 Binary files a/docs/intermediate/monitoring/geonode_monitoring/img/admin-monitoring-service-local-system-geonode.png and /dev/null differ diff --git a/docs/intermediate/monitoring/geonode_monitoring/img/dashboard-error-details-request.png b/docs/intermediate/monitoring/geonode_monitoring/img/dashboard-error-details-request.png deleted file mode 100644 index f1dba5f84d8..00000000000 Binary files a/docs/intermediate/monitoring/geonode_monitoring/img/dashboard-error-details-request.png and /dev/null differ diff --git a/docs/intermediate/monitoring/geonode_monitoring/img/dashboard-error-details.png b/docs/intermediate/monitoring/geonode_monitoring/img/dashboard-error-details.png deleted file mode 100644 index fc3731467f7..00000000000 Binary files a/docs/intermediate/monitoring/geonode_monitoring/img/dashboard-error-details.png and /dev/null differ diff --git a/docs/intermediate/monitoring/geonode_monitoring/img/dashboard-errors-list.png b/docs/intermediate/monitoring/geonode_monitoring/img/dashboard-errors-list.png deleted file mode 100644 index 211487f7e51..00000000000 Binary files a/docs/intermediate/monitoring/geonode_monitoring/img/dashboard-errors-list.png and /dev/null differ diff --git a/docs/intermediate/monitoring/geonode_monitoring/img/dashboard-hw-performance-charts-button.png b/docs/intermediate/monitoring/geonode_monitoring/img/dashboard-hw-performance-charts-button.png deleted file mode 100644 index 6810dad0ab4..00000000000 Binary files a/docs/intermediate/monitoring/geonode_monitoring/img/dashboard-hw-performance-charts-button.png and /dev/null differ diff --git a/docs/intermediate/monitoring/geonode_monitoring/img/dashboard-hw-performance-charts.png b/docs/intermediate/monitoring/geonode_monitoring/img/dashboard-hw-performance-charts.png deleted file mode 100644 index 10387d77e3e..00000000000 Binary files a/docs/intermediate/monitoring/geonode_monitoring/img/dashboard-hw-performance-charts.png and /dev/null differ diff --git a/docs/intermediate/monitoring/geonode_monitoring/img/dashboard-hw-performance.png b/docs/intermediate/monitoring/geonode_monitoring/img/dashboard-hw-performance.png deleted file mode 100644 index b336eddc1a9..00000000000 Binary files a/docs/intermediate/monitoring/geonode_monitoring/img/dashboard-hw-performance.png and /dev/null differ diff --git a/docs/intermediate/monitoring/geonode_monitoring/img/dashboard-indicators-errors.png b/docs/intermediate/monitoring/geonode_monitoring/img/dashboard-indicators-errors.png deleted file mode 100644 index a82e113fe92..00000000000 Binary files a/docs/intermediate/monitoring/geonode_monitoring/img/dashboard-indicators-errors.png and /dev/null differ diff --git a/docs/intermediate/monitoring/geonode_monitoring/img/dashboard-indicators-ok.png b/docs/intermediate/monitoring/geonode_monitoring/img/dashboard-indicators-ok.png deleted file mode 100644 index 863918a69ed..00000000000 Binary files a/docs/intermediate/monitoring/geonode_monitoring/img/dashboard-indicators-ok.png and /dev/null differ diff --git a/docs/intermediate/monitoring/geonode_monitoring/img/dashboard-notifications-config.png b/docs/intermediate/monitoring/geonode_monitoring/img/dashboard-notifications-config.png deleted file mode 100644 index ec890faf3a1..00000000000 Binary files a/docs/intermediate/monitoring/geonode_monitoring/img/dashboard-notifications-config.png and /dev/null differ diff --git a/docs/intermediate/monitoring/geonode_monitoring/img/dashboard-notifications-list.png b/docs/intermediate/monitoring/geonode_monitoring/img/dashboard-notifications-list.png deleted file mode 100644 index 852652c7659..00000000000 Binary files a/docs/intermediate/monitoring/geonode_monitoring/img/dashboard-notifications-list.png and /dev/null differ diff --git a/docs/intermediate/monitoring/geonode_monitoring/img/dashboard-sw-performance-chart-layers.png b/docs/intermediate/monitoring/geonode_monitoring/img/dashboard-sw-performance-chart-layers.png deleted file mode 100644 index 83d989a8780..00000000000 Binary files a/docs/intermediate/monitoring/geonode_monitoring/img/dashboard-sw-performance-chart-layers.png and /dev/null differ diff --git a/docs/intermediate/monitoring/geonode_monitoring/img/dashboard-sw-performance-chart.png b/docs/intermediate/monitoring/geonode_monitoring/img/dashboard-sw-performance-chart.png deleted file mode 100644 index 5518e703ded..00000000000 Binary files a/docs/intermediate/monitoring/geonode_monitoring/img/dashboard-sw-performance-chart.png and /dev/null differ diff --git a/docs/intermediate/monitoring/geonode_monitoring/img/dashboard-sw-performance-charts-button.png b/docs/intermediate/monitoring/geonode_monitoring/img/dashboard-sw-performance-charts-button.png deleted file mode 100644 index c0e816437fd..00000000000 Binary files a/docs/intermediate/monitoring/geonode_monitoring/img/dashboard-sw-performance-charts-button.png and /dev/null differ diff --git a/docs/intermediate/monitoring/geonode_monitoring/img/dashboard-sw-performance.png b/docs/intermediate/monitoring/geonode_monitoring/img/dashboard-sw-performance.png deleted file mode 100644 index 78a54d36eb0..00000000000 Binary files a/docs/intermediate/monitoring/geonode_monitoring/img/dashboard-sw-performance.png and /dev/null differ diff --git a/docs/intermediate/monitoring/geonode_monitoring/img/dashboard-top-bar.png b/docs/intermediate/monitoring/geonode_monitoring/img/dashboard-top-bar.png deleted file mode 100644 index 116f0b94c51..00000000000 Binary files a/docs/intermediate/monitoring/geonode_monitoring/img/dashboard-top-bar.png and /dev/null differ diff --git a/docs/intermediate/monitoring/geonode_monitoring/img/homepage-admin-link.png b/docs/intermediate/monitoring/geonode_monitoring/img/homepage-admin-link.png deleted file mode 100644 index 9a02c798883..00000000000 Binary files a/docs/intermediate/monitoring/geonode_monitoring/img/homepage-admin-link.png and /dev/null differ diff --git a/docs/intermediate/monitoring/geonode_monitoring/img/homepage-monitoring-link.png b/docs/intermediate/monitoring/geonode_monitoring/img/homepage-monitoring-link.png deleted file mode 100644 index 54524c33441..00000000000 Binary files a/docs/intermediate/monitoring/geonode_monitoring/img/homepage-monitoring-link.png and /dev/null differ diff --git a/docs/intermediate/monitoring/geonode_monitoring/img/monitoring-alerts-notification-link.png b/docs/intermediate/monitoring/geonode_monitoring/img/monitoring-alerts-notification-link.png deleted file mode 100644 index 259eb1c69d3..00000000000 Binary files a/docs/intermediate/monitoring/geonode_monitoring/img/monitoring-alerts-notification-link.png and /dev/null differ diff --git a/docs/intermediate/monitoring/geonode_monitoring/img/monitoring-alerts-unfolded.png b/docs/intermediate/monitoring/geonode_monitoring/img/monitoring-alerts-unfolded.png deleted file mode 100644 index b9b0e1427ef..00000000000 Binary files a/docs/intermediate/monitoring/geonode_monitoring/img/monitoring-alerts-unfolded.png and /dev/null differ diff --git a/docs/intermediate/monitoring/geonode_monitoring/img/monitoring-alerts.png b/docs/intermediate/monitoring/geonode_monitoring/img/monitoring-alerts.png deleted file mode 100644 index 274b7691b35..00000000000 Binary files a/docs/intermediate/monitoring/geonode_monitoring/img/monitoring-alerts.png and /dev/null differ diff --git a/docs/intermediate/monitoring/geonode_monitoring/img/monitoring-dashboard.png b/docs/intermediate/monitoring/geonode_monitoring/img/monitoring-dashboard.png deleted file mode 100644 index 3007f8ad1a1..00000000000 Binary files a/docs/intermediate/monitoring/geonode_monitoring/img/monitoring-dashboard.png and /dev/null differ diff --git a/docs/intermediate/monitoring/geonode_monitoring/index.rst b/docs/intermediate/monitoring/geonode_monitoring/index.rst deleted file mode 100644 index 154034b03bf..00000000000 --- a/docs/intermediate/monitoring/geonode_monitoring/index.rst +++ /dev/null @@ -1,467 +0,0 @@ -Monitoring -========== - -Internal Monitoring Application (geonode.monitoring) ----------------------------------------------------- - -.. note:: This application requires MaxMind's GeoIP database file. - -Base concepts and objects -~~~~~~~~~~~~~~~~~~~~~~~~~ - -GeoNode monitoring is a configurable monitoring application, that allows internal resources and hardware resources monitoring for GeoNode installations, including GeoServer deployments. - -Monitoring application is configurable, so different deployment scenarios could be handled - from GeoNode and GeoServer running on single host, through distributed installations, where GeoServer is deployed to several hosts. - -Monitoring application uses three base entity classes to describe elements of reality: ``Host``, ``Service Type`` and ``Service``. - -* ``Host`` is an object describing physical (or virtual) instance of operating system on which GN or GS is running. - This object exists only for grouping and is not used directly by monitoring. - -* ``Service Type`` is a description of kind of Service. Depending on service type, different metrics are stored, and different data - collection mechanisms are used. Additionally, for system monitoring, it's not conducted directly, but with GeoNode or GeoServer as - monitoring agent. That means, no additional software installation is needed to monitor system, but also, hosts that don't have GeoNode - or GeoServer installed, won't be monitored. There are four service types: - - * ``hostgeonode``, ``hostgeoserver`` - those types describe system monitoring probes that are running with GeoNode or GeoServer respectively, - - * ``geonode``, ``geoserver`` - application-level probes that monitor one specific GeoNode or GeoServer instance. - -* ``Service`` describes one specific instance of probe, either host-level or application-level. - Service references Host and Service Type. Each service must be named, and name should be system-wide unique. - -As mentioned above, each ``Service Type`` keeps a set of ``metrics``, specific for that type. -A ``metric`` is a description of measured value, for example: number of requests, response size or time, cpu usage, free memory etc. -Each ``Service Type`` has it's own metrics set. Metric value may be either value counter (like country of user), -numeric counter (like number of requests) or rate (like bytes in/out on network interface). - -Besides metric data, monitoring will also store exception information for exceptions that were captured during request handling. - -Data are collected periodically (at most every 1 minute), aggregated and stored in aggregated form. -User can see data from predefined relative periods (last minute, last 10 minutes, last hour, last day, last week). - -User can enable and configure automated checks, which will be run after each collection/aggregation cycle, and will emit notifications -if metric values in that run exceed configured thresholds. - -Analytics -~~~~~~~~~ - -GeoNode monitoring application makes also available information about resources usage at user level. - -Those information are collected whenever an event occurs about some resource. -Events can be of different types (``EventType``) which refer to common user activities on resources (upload, view, download, etc.). -Those data are stored using a dedicated ``metric`` and aggregated based on a configurable granularity, depending on the time interval considered and the wanted resolution. - -So the analytics client, once defined a time interval and a time frame, can retrieve stats such as: - -- total number of unique visitors; -- number of unique visitors who trigger a specific type of event; -- number of unique visitors who trigger events on some resource type; -- number of unique visitors in a given country; -- number of unique visitors who trigger events on some specific resource; -- number of unique visitors considering a combination of multiple conditions (for example an event type on some resource type). - -Installation -~~~~~~~~~~~~ - -.. warning:: This plugin requires a Potgresql DB backend enabled - -* ensure ``UTC`` Timezone to your DB - - .. code-block:: python - - psql -c 'set timezone=UTC;' - -* enable `MONITORING_ENABLED <../../basic/settings/index.html#monitoring-enabled>`_ flag and ensure that following code is in your settings: - -.. code-block:: python - - # Settings for MONITORING plugin - CORS_ORIGIN_ALLOW_ALL = ast.literal_eval(os.environ.get('CORS_ORIGIN_ALLOW_ALL', 'False')) - GEOIP_PATH = os.getenv('GEOIP_PATH', os.path.join(PROJECT_ROOT, 'GeoIPCities.dat')) - MONITORING_ENABLED = ast.literal_eval(os.environ.get('MONITORING_ENABLED', 'True')) - - MONITORING_CONFIG = os.getenv("MONITORING_CONFIG", None) - MONITORING_HOST_NAME = os.getenv("MONITORING_HOST_NAME", HOSTNAME) - MONITORING_SERVICE_NAME = os.getenv("MONITORING_SERVICE_NAME", 'local-geonode') - - # how long monitoring data should be stored - MONITORING_DATA_TTL = timedelta(days=int(os.getenv("MONITORING_DATA_TTL", 7))) - - # this will disable csrf check for notification config views, - # use with caution - for dev purpose only - MONITORING_DISABLE_CSRF = ast.literal_eval(os.environ.get('MONITORING_DISABLE_CSRF', 'False')) - - if MONITORING_ENABLED: - if 'geonode.monitoring' not in INSTALLED_APPS: - INSTALLED_APPS += ('geonode.monitoring',) - if 'geonode.monitoring.middleware.MonitoringMiddleware' not in MIDDLEWARE_CLASSES: - MIDDLEWARE_CLASSES += \ - ('geonode.monitoring.middleware.MonitoringMiddleware',) - - # skip certain paths to not to mud stats too much - MONITORING_SKIP_PATHS = ('/api/o/', - '/monitoring/', - '/admin', - '/jsi18n', - STATIC_URL, - MEDIA_URL, - re.compile('^/[a-z]{2}/admin/'), - ) - - # configure aggregation of past data to control data resolution - # list of data age, aggregation, in reverse order - # for current data, 1 minute resolution - # for data older than 1 day, 1-hour resolution - # for data older than 2 weeks, 1 day resolution - MONITORING_DATA_AGGREGATION = ( - (timedelta(seconds=0), timedelta(minutes=1),), - (timedelta(days=1), timedelta(minutes=60),), - (timedelta(days=14), timedelta(days=1),), - ) - - # privacy settings - USER_ANALYTICS_ENABLED = ast.literal_eval(os.getenv('USER_ANALYTICS_ENABLED', 'False')) - -* run - - .. code-block:: shell - - DJANGO_SETTINGS_MODULE=.settings python manage.py migrate monitoring - - to apply db schema changes and insert initial data - -* run - - .. code-block:: shell - - DJANGO_SETTINGS_MODULE=.settings python manage.py updategeoip - - to fetch MaxMind's GeoIP database file. It will be written to path specified by `GEOIP_PATH` setting. - -* run - - .. code-block:: shell - - DJANGO_SETTINGS_MODULE=.settings python manage.py collect_metrics -n -t xml -f --since='' - - to create first metrics. - - .. warning:: - - Replace ```` with a real date time to start with. - -* update ``Sites`` from admin; make sure it contains a correct host name -* do not forget to enable notifications and configure them from user profile - -Enable the collect_metrics ``cron`` -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. warning:: Here below you will find instructions for a Ubuntu 16.04/18.04 based machine, but the procedure is similar for other OSs. - The basic concept is that you must allow the system to run the command every minute (**without -f and since**): - - .. code-block:: shell - - DJANGO_SETTINGS_MODULE=.settings python manage.py collect_metrics -n -t xml - -cront job -^^^^^^^^^ - -.. code:: python - - sudo crontab -e - -.. code:: python - - # Add the following line at the bottom; this will run the supervisor command every minute - * * * * * supervisorctl start geonode-monitoring - -supervisor -^^^^^^^^^^ - -.. code:: python - - sudo apt install supervisor - sudo service supervisor restart - sudo update-rc.d supervisor enable - -.. code:: python - - sudo vim /etc/supervisor/conf.d/geonode-monitoring.conf - -.. code:: python - - [program:geonode-monitoring] - command=/geonode/bin/python -W ignore /geonode/manage.py collect_metrics -n -t xml - directory = - environment=DJANGO_SETTINGS_MODULE=".settings" - user= - numproc=1 - stdout_logfile=/var/log/geonode-celery.log - stderr_logfile=/var/log/geonode-celery.log - autostart = true - autorestart = true - startsecs = 10 - stopwaitsecs = 600 - priority = 998 - -.. code:: python - - sudo service supervisor restart - sudo supervisorctl start geonode-monitoring - sudo supervisorctl status geonode-monitoring - -.. code:: python - - sudo vim /etc/hosts - -.. code:: python - - 127.0.0.1 localhost - - - # The following lines are desirable for IPv6 capable hosts - -Configuration -~~~~~~~~~~~~~ - -In order to have working monitoring, at least ``Service`` should be configured. -Let's assume following deployment scenario: - - * there's one machine, ``geo01`` - - * ``geo01`` hosts both GeoNode and GeoServer (including PostgreSQL). - - * applications are served with nginx+uwsgi, on port 80, but they are reachable on ``localhost`` address. - - * GeoServer is served from ``/geoserver/`` path - - * GeoNode is served from ``/`` path - -Here's step-by-step instruction how to create monitoring setup for deployment scenario: - - -1. Log in as admin, and go to admin section: - - .. image:: img/homepage-admin-link.png - :alt: go to admin section - -2. Go to **monitoring** section (or type ``/admin/monitoring/`` as a path in URL): - - .. image:: img/admin-monitoring-section.png - :alt: go to admin/monitoring section - -3. Go to **Hosts**: - - .. image:: img/admin-monitoring-hosts-services-underline.png - :alt: go to admin/monitoring/hosts section - -4. Click on **Add host +**: - - .. image:: img/admin-monitoring-add-host.png - :alt: add host - -5. Enter following information: - * **host**: `localhost` - * **ip**: `127.0.0.1` - Note, that **host** value is arbitrary. You can enter other name if you like. - Don't forget to save. - - .. image:: img/admin-monitoring-host.png - :alt: added host - -6. Go to **Services**: - - .. image:: img/admin-monitoring-hosts-services-underline.png - :alt: go to admin/monitoring/services section - -7. Click on **Add service +**: - - .. image:: img/admin-monitoring-add-service.png - :alt: add service - -8. Enter following information: - - * **name**: `local-geonode` - * **host**: `localhost` - * **service type**: `geonode` - - .. image:: img/admin-monitoring-service-local-geonode.png - :alt: add geonode service - -9. Add another **Service** Enter following information: - - * **name**: `local-system-geonode` - * **host**: `localhost` - * **service type**: `hostgeonode` - * **url**: `http://localhost/` (should point to GeoNode home page) - - .. image:: img/admin-monitoring-service-local-system-geonode.png - :alt: add hostgeonode service - -10. Add another **Service** and enter following information: - - * **name**: `local-geoserver` - * **host**: `localhost` - * **service type**: `geoserver` - * **url**: `http://localhost/geoserver/` (should point to GeoServer home page) - - .. image:: img/admin-monitoring-service-local-geoserver.png - :alt: add geoserver service - - -To summarize, following entries should be created in admin/monitoring: - -* Host: ``localhost``, with ip: 127.0.0.1 - -* Service: ``local-geonode``: - * host ``localhost`` - * type ``geonode`` - -* Service: ``local-geoserver``: - * url ``http://localhost/geoserver/`` - * host ``localhost`` - * type ``geoserver`` - -* Service: ``local-system-geonode`` - * url ``http://localhost/`` - * host ``localhost`` - * type ``hostgeonode`` - -Usage -~~~~~ - -Monitoring interface is available for superusers only. It's available in profile menu: - -.. image:: img/homepage-monitoring-link.png - :alt: monitoring link - -Dashboard -^^^^^^^^^ - -Main view offers overview of recent situation in GeoNode deployment. - -.. image:: img/monitoring-dashboard.png - :alt: monitoring dashboard - - -Top bar and indicators -^^^^^^^^^^^^^^^^^^^^^^ - -.. figure:: img/dashboard-indicators-ok.png - :alt: indicators in ok state - -With top bar buttons User can: - - * go back from nested interface elements (charts, alerts, errors) - * select time window from which data will be aggregated and shown (last 10 minutes, last 1 hour, last day or last week from now) - * see what's currently used time window - * enable/disable autorefresh - -Below there are four main health indicators: - - * aggregated **Health Check** information. - This element will be: - - * `green` if there is no alerts nor errors - * `yellow` if there are alerts - * `red` if there are errors - - * **Uptime** that shows GeoNode's system uptime. - - * **Alerts** shows number of notifications from defined checks. When clicked, Alerts box will show detailed information . See Notifications description for details. - - * **Errors** - shows how many errors were captured during request processing. When clicked, Errors box will show detailed list of captured errors. See Errros description for details. - -.. figure:: img/dashboard-indicators-errors.png - :alt: indicators in ok state - -Indicators in error state - - -Software Performance -^^^^^^^^^^^^^^^^^^^^ - -Software Performance view shows GeoServer web service statistics, for all requests monitored and detailed, OWS-specific, per service type (WMS, WFS, OCS etc). - -.. image:: img/dashboard-sw-performance.png - -Clicking on - -.. image:: img/dashboard-sw-performance-charts-button.png - :align: center - -will show charts with data history for overall performance and per-OWS performance: - -.. image:: img/dashboard-sw-performance-chart.png - - -Hartware Performance -^^^^^^^^^^^^^^^^^^^^ - -Hardware performance box shows hardware usage statistics for selected host (monitored with any of hostgeonode or hostgeoserver type Service): % of CPU usage and average memory consumption. User can select from which host data will be presented. - -.. image:: img/dashboard-hw-performance.png - -Clicking on - -.. image:: img/dashboard-hw-performance-charts-button.png - :align: center - -will show charts with data history for selected host and time period - -.. image:: img/dashboard-hw-performance-charts.png - - -Errors -^^^^^^ - -Errors view will show list of captured errors in GeoNode and GeoServer. List contents is displayed for selected time window. - -.. image:: img/dashboard-errors-list.png - -For each error, details are available: - * error class, message and stack trace - * basic request context (IP, path, user agent) - -.. image:: img/dashboard-error-details.png - - -Alerts -^^^^^^ - -An alert is a descriptive information on situation when observed metric contains values outside allowed range (for example, response time is above 30 seconds, or no requests were served within last 30 minutes). Alerts are generated by notifications mechanism described below. - -Alerts view will show list of alerts for current moment (alerts that were generated in past are not displayed here): - -.. image:: img/monitoring-alerts.png - -Each alert contains more descriptive information what is wrong: - -.. image:: img/monitoring-alerts-unfolded.png - -Notifications -+++++++++++++ - -Notification mechanism (not to be confused with notifications application in GeoNode) is a way to inform selected users about situations, where collected metric data would indicate a problem with deployment. Notifications are accessible from Alerts view: - -.. image:: img/monitoring-alerts-notification-link.png - -There can be several notification configurations available. - - -.. image:: img/dashboard-notifications-list.png - -Each notification configuration contains two main elements: - - * list of email addressess which should be notified when alert is generated - * list of checks (at least one check must be in invalid state to generate alert) - -.. image:: img/dashboard-notifications-config.png - -User can add arbitrary number of emails. Email address doesn't need to point to user registered in GeoNode instance. If email provided doesn't belong to any of users, alert will be send as a regular email. If email provided can be associated with specific user, notifications application (and thus, notification settings for that user) will be used to send alert. - -Integration with GeoHealthCheck -------------------------------- - -GeoNode can also be easily monitored with external tools, like `GeoHealthCheck `_. See `Documentation on adding resources `_ for details. diff --git a/docs/intermediate/monitoring/index.rst b/docs/intermediate/monitoring/index.rst deleted file mode 100644 index bcd304b6a07..00000000000 --- a/docs/intermediate/monitoring/index.rst +++ /dev/null @@ -1,7 +0,0 @@ -.. toctree:: - :maxdepth: 3 - - geonode_monitoring/index - api/index - user_analytics/index - notifications/index diff --git a/docs/intermediate/monitoring/notifications/index.rst b/docs/intermediate/monitoring/notifications/index.rst deleted file mode 100644 index 68604b52120..00000000000 --- a/docs/intermediate/monitoring/notifications/index.rst +++ /dev/null @@ -1,539 +0,0 @@ -Monitoring: Notifications -========================= - -Notifications are part of monitoring that is run after each data collection cycle. -It's configurable mechanism to check if metrics values are within allowed value range, and if not, send notification to designated receivers (registered users or external emails). - -Data model ----------- - -Notification mechanism is composed of several classes, responsible for different aspects: - -* High-level configuration: `NotificationCheck`: - - keeps general description, list of metric check definition, send grace period configuration and last send marker, list of users to which notification should be delivered (in helper table, `NotificationReceiver` class). - -* Per-metric definition: `MetricNotificationDefinition`: - - keeps per-metric-per-check configuration: name of metric, min, max values allowed for user, check type (if value should be below or above given threshold, or should last read be not older than specific period from metric check), additional scope for check (resource, label, ows service - this part is partially implemented). Definition object is created from `NotificationCheck.user_tresholds` data, and is used to generate validation form. - Note, that one `NotificationCheck` can have several definition items, for set of different metrics. Definition rows are created when `NotificationCheck` is created, or updated. - -* Per-metric check configuration: `MetricNotificationCheck` - - Keeps per-metric-per-check configuration: metric and threshold values. It is created after user submits configuration form for specific notification. - -Workflow --------- - -Notifications are checked after each collection/processing period in collection script, by calling `CollectorAPI.emit_notifications(for_timestamp)`. This will do following: - -* get all notifications, -* for each notification, will get all notification checks -* for each notification check, it will get metric valid for given timestamp and check if value matches given criteria -* each check can raise exception, which will be captured in caller, and for each notification, list of errors will be returned -* based on list of notifications and errors, alerts will be generated and send to users, unless last delivery was before grace period is finished. - -Additionally, notifications expose ``/monitoring/api/status/`` :ref:`status-api`, which will show errors detected at the moment of request. - -Web API -======= - -.. _status-api: - -Status API ----------- - -Status endpoint presents current state of error checking performed by notifications. -Frontend can make requests periodically to this endpoint. -There is no history view for status at the moment. -Status response is wrapped with standard response envelope. -Non-error response will have `status` key set to `ok` and `success` to `true`, otherwise `errors` will be not empty. - -No errors response: - -``GET /monitoring/api/status/`` - -.. code-block:: json - - { - "status": "ok", - "data": [], - "success": true - } - -Response with errors reported: - -.. code-block:: json - - { - "status": "ok", - "data": [ - { - "problems": [ - { - "threshold_value": "2017-08-29T10:45:26.142", - "message": "Value collected too far in the past", - "name": "request.count", - "severity": "warning", - "offending_value": "2017-08-25T16:41:00" - } - ], - "check": { - "grace_period": { - "seconds": 600, - "class": "datetime.timedelta" - }, - "last_send": null, - "description": "detects when requests are not handled", - "severity": "warning", - "user_threshold": { - "3": { - "max": 10, - "metric": "request.count", - "steps": null, - "description": "Number of handled requests is lower than", - "min": 0 - }, - "4": { - "max": null, - "metric": "request.count", - "steps": null, - "description": "No response for at least", - "min": 60 - }, - "5": { - "max": null, - "metric": "response.time", - "steps": null, - "description": "Response time is higher than", - "min": 500 - } - }, - "id": 2, - "name": "geonode is not working" - } - } - ], - "success": true - } - -Response with reported errors contains list of check elements in `data` element. Each check element contains: - -* `check` - serialized `NotificationCheck` object, which was used -* `problems` - list of metric checks that failed. Each element contains name of metric, severity, error message, measured and threshold value. - -Severity -~~~~~~~~ - -Severity is a textual description of potential impact of error. There are three values: `warning`, `error` and `fatal`. - -Notification list ------------------ - -This call will return list of available notifications: - -``GET /monitoring/api/notifications/`` - -.. code-block:: json - - { - "status": "ok", - "data": { - "problems": [ - { - "threshold_value": "10.0000", - "check_url": "/monitoring/api/notifications/config/2/", - "name": "request.count", - "check_id": 2, - "description": "Metric value for request.count should be at least 10, got 4 instead", - "offending_value": "4.0000", - "message": "Number of handled requests is lower than 4", - "severity": "error" - } - ], - "health_level": "error" - }, - "success": true - } - -Response will contain list of notifications summary in `data` key. Each element will have: - -* `name` of metric checked -* `message` is error message generated by notification. This describes what the problem is. -* `description` more detailed information what which check failed. -* `offending_value` and `threshold_value` are values that were compared (`offending_value` is acutal value from metric data) -* `check_url` to notification details -* `severity` of error - -Also, `data` will have highest `severity` value available in `health_level`. - -Notification details --------------------- - -This will return details for notification, including form and list of allowed fields: - -``GET /monitoring/api/notifications/config/{{notification_id}}/`` - -.. code-block:: json - - { - "status": "ok", - "errors": {}, - "data": { - "fields": [ - { - "is_enabled": true, - "use_resource": false, - "description": "Number of handled requests is lower than", - "max_value": "10.0000", - "metric": { - "class": "geonode.contrib.monitoring.models.Metric", - "name": "request.count", - "id": 2 - }, - "min_value": "0.0000", - "use_label": false, - "use_ows_service": false, - "field_option": "min_value", - "use_service": false, - "steps_calculated": [ - "0.0000", - "3.33", - "6.67", - "10.0" - ], - "current_value": "30.0000", - "steps": 3, - "notification_check": { - "class": "geonode.contrib.monitoring.models.NotificationCheck", - "name": "geonode is not working", - "id": 2 - }, - "field_name": "request.count.min_value", - "id": 3, - "unit": "" - }, - { - "is_enabled": true, - "use_resource": false, - "description": "No response for at least", - "max_value": null, - "metric": { - "class": "geonode.contrib.monitoring.models.Metric", - "name": "request.count", - "id": 2 - }, - "min_value": "60.0000", - "use_label": false, - "use_ows_service": false, - "field_option": "max_timeout", - "use_service": false, - "steps_calculated": null, - "current_value": { - "seconds": 120, - "class": "datetime.timedelta" - }, - "steps": null, - "notification_check": { - "class": "geonode.contrib.monitoring.models.NotificationCheck", - "name": "geonode is not working", - "id": 2 - }, - "field_name": "request.count.max_timeout", - "id": 4, - "unit": "" - }, - { - "is_enabled": false, - "use_resource": false, - "description": "Response time is higher than", - "max_value": null, - "metric": { - "class": "geonode.contrib.monitoring.models.Metric", - "name": "response.time", - "id": 11 - }, - "min_value": "500.0000", - "use_label": false, - "use_ows_service": false, - "field_option": "max_value", - "use_service": false, - "steps_calculated": null, - "current_value": null, - "steps": null, - "notification_check": { - "class": "geonode.contrib.monitoring.models.NotificationCheck", - "name": "geonode is not working", - "id": 2 - }, - "field_name": "response.time.max_value", - "id": 5, - "unit": "s" - }, - { - "is_enabled": false, - "use_resource": false, - "description": "dsfdsf", - "max_value": null, - "metric": { - "class": "geonode.contrib.monitoring.models.Metric", - "name": "response.time", - "id": 11 - }, - "min_value": null, - "use_label": false, - "use_ows_service": false, - "field_option": "min_value", - "use_service": false, - "steps_calculated": null, - "current_value": null, - "steps": null, - "notification_check": { - "class": "geonode.contrib.monitoring.models.NotificationCheck", - "name": "geonode is not working", - "id": 2 - }, - "field_name": "response.time.min_value", - "id": 6, - "unit": "s" - }, - { - "is_enabled": true, - "use_resource": false, - "description": "Incoming traffic should be higher than", - "max_value": null, - "metric": { - "class": "geonode.contrib.monitoring.models.Metric", - "name": "network.in.rate", - "id": 34 - }, - "min_value": null, - "use_label": false, - "use_ows_service": false, - "field_option": "min_value", - "use_service": false, - "steps_calculated": null, - "current_value": "10000000.0000", - "steps": null, - "notification_check": { - "class": "geonode.contrib.monitoring.models.NotificationCheck", - "name": "geonode is not working", - "id": 2 - }, - "field_name": "network.in.rate.min_value", - "id": 7, - "unit": "B/s" - } - ], - "form": "\n\n\n\n\n\n\n\n", - "notification": { - "grace_period": { - "seconds": 60, - "class": "datetime.timedelta" - }, - "last_send": "2017-09-04T13:13:15.203", - "description": "detects when requests are not handled", - "severity": "error", - "user_threshold": { - "request.count.max_timeout": { - "max": null, - "metric": "request.count", - "steps": null, - "description": "No response for at least", - "min": 60 - }, - "response.time.max_value": { - "max": null, - "metric": "response.time", - "steps": null, - "description": "Response time is higher than", - "min": 500 - }, - "request.count.min_value": { - "max": 10, - "metric": "request.count", - "steps": 3, - "description": "Number of handled requests is lower than", - "min": 0 - } - }, - "active": true, - "id": 2, - "name": "geonode is not working" - } - }, - "success": true - } - -Returned keys in `data` element: - -* `fields` - list of form fields, including detailed per-resource configuration flags -* `form` - rendered user form, which can be displayed -* `notification` - serialized notification object with `user_thresholds` list (this is a base to create `fields` objects) - -Frontend should use `fields` list to create whole form in client-side: - -* field name is stored in `field_name`. -* field label can be constructed from `description` -* unit can be extracted from `unit` field -* if field definition provides list in `steps_calculated`, this should be used to construct selection/dropdown, otherwise text input should be displayed. If possible, validation should take into account `min_value` and `max_value`. -* currently set value is available in `current_value` field. -* each field has `is_enabled` property, which tells if field is enabled. Currently this value is calculated in following way: field is enabled if `current_value` is not `None`. This may change in the future. - -Additionally, each notification configuration accepts list of emails in `emails` field. This field should be send as a list of emails joined with new line char (`\n`). - -Form should be submitted to the same url as configuration source (``/monitoring/api/notifications/config/{id}/``), see below. - -Notification edition (by user) ------------------------------- - -Following API call allows user to configure notification by setting receivers and adjust threshold values for checks: - -``POST /monitoring/api/notifications/config/{{notification_check_id}}/`` - -.. code-block:: python - - request.count.max_value=val - request.count.min_value=1 - emails=list of emails - -Response contains serialized `NotificationCheck` in `data` element, if no errors were captured during form processing: - -.. code-block:: json - - { - "status": "ok", - "errors": {}, - "data": { - "grace_period": { - "seconds": 600, - "class": "datetime.timedelta" - }, - "last_send": null, - "description": "more test", - "severity": "error", - "user_threshold": { - "request.count.max_value": { - "max": null, - "metric": "request.count", - "steps": null, - "description": "Max number of request", - "min": 1000 - }, - "request.count.min_value": { - "max": 100, - "metric": "request.count", - "steps": null, - "description": "Min number of request", - "min": 0 - } - }, - "id": 293, - "name": "test" - }, - "success": true - } - -Error (non-200) response will have `errors` key populated: - -.. code-block:: json - - { - "status": "error", - "errors": { - "user_threshold": [ - "This field is required." - ], - "name": [ - "This field is required." - ], - "description": [ - "This field is required." - ] - }, - "data": [], - "success": false - } - -Notification creation ---------------------- - -This API call allows to create new notification, it's different in form layout from edition: - -``POST /monitoring/api/notifications/`` - -.. code-block:: python - - name=Name of notification (geonode doesn't work) - description=This will check if geonode is serving any data - emails= - user_thresholds= - severity= - -Payload elements: - -* `name`, `description` are values visible for user -* `severity` severity value -* `emails` is a list of emails, however, it is encoded to a string, where each email is in new line: - - .. code-block:: python - - email1@test.com - email2@test.com - -* `user_thresholds` is a json encoded list of per-metric-per-check configurations. Each element of list should be a 10-elemnt list, containing: - - * name of metric - * field check option (one of three values: `min_value`, `max_value` or `max_timeout`) - * flag, if metric check can use service - * flag, if metric check can use resource - * flag, if metric check can use label - * flag, if metric check can use ows service - * minimum value for user input (no minimum check if None) - * maximum value for user input (no maximum check if None) - * steps count is a number of steps to generate for user input, so user can select value from select list instead of typing. This will have effect only if both min and max values are also provided - Sample payload for `user_thresholds`: - - .. code-block:: python - - [ - ('request.count', 'min_value', False, False, False, False, 0, 100, None, "Min number of request"), - ('request.count', 'max_value', False, False, False, False, 1000, None, None, "Max number of request"), - ] - -Response is a serialized `NotificationCheck` wrapped with standard response envelope (status, errors etc). -Actual data is in `data` key. If processing failed, for example because of form validation errors, response will be non-200 OK, and `errors` key will be populated. - -.. code-block:: json - - { - "status": "ok", - "errors": {}, - "data": { - "grace_period": { - "seconds": 600, - "class": "datetime.timedelta" - }, - "last_send": null, - "description": "more test", - "user_threshold": { - "request.count.max_value": { - "max": 100, - "metric": "request.count", - "steps": null, - "description": "Min number of request", - "min": 0 - }, - "request.count.min_value": { - "max": null, - "metric": "request.count", - "steps": null, - "description": "Max number of request", - "min": 1000 - } - }, - "id": 257, - "name": "test" - }, - "success": true - } diff --git a/docs/intermediate/monitoring/user_analytics/index.rst b/docs/intermediate/monitoring/user_analytics/index.rst deleted file mode 100644 index bbf38479012..00000000000 --- a/docs/intermediate/monitoring/user_analytics/index.rst +++ /dev/null @@ -1,716 +0,0 @@ -Monitoring: User Analytics -========================== - -Purpose -------- - -UA should provide information about GeoNode resources usage at user level (not request level, like plain monitoring). - -Requests --------- - -1. total number of unique sessions on GeoNode (excluding ows requests) per day. This gives a base view of the reach. - - * requests from all sessions of all types, ows and non-ows - - ``GET /monitoring/api/metric_data/request.users/?last=(x*86400)&interval=86400&group_by=label`` - - * non-ows related - - ``GET /monitoring/api/metric_data/request.users/?`` - ``last=(x*86400)&interval=86400&group_by=label&event_type=other`` - - * only ows related - - ``GET /monitoring/api/metric_data/request.users/?`` - ``last=(x*86400)&interval=86400&group_by=label&event_type=OWS:ALL`` - - .. code-block:: json - - { - "data": { - "input_valid_from": "2018-07-11T15:41:06.419Z", - "input_valid_to": "2018-07-12T15:41:06.419Z", - "data": [ - { - "valid_from": "2018-07-11T15:41:06.419Z", - "data": [ - { - "samples_count": 82, - "val": 9, - "min": "0.0000", - "max": "24.0000", - "sum": "82.0000", - "metric_count": 16 - } - ], - "valid_to": "2018-07-12T15:41:06.419Z" - } - ], - "metric": "request.users", - "interval": 86400.0, - "type": "value", - "axis_label": "Count", - "label": null - } - } - -2. total number of unique sessions per URL (excluding ows requests). Let me see how many users visits the layers page or the maps page - - * get number of unique tracking ids for urls - - ``GET /monitoring/api/metric_data/request.users/?`` - ``last=(x*86400)&interval=86400&group_by=resource_on_label&resource_type=url&event_type=other`` - - .. code-block:: json - - { - "data": { - "input_valid_from": "2018-07-11T15:39:25.126Z", - "input_valid_to": "2018-07-12T15:39:25.126Z", - "data": [ - { - "valid_from": "2018-07-11T15:39:25.126Z", - "data": [ - { - "resource": { - "type": "url", - "name": "/layers/", - "id": 15 - }, - "metric_count": 2, - "val": 2, - "min": "1.0000", - "max": "1.0000", - "sum": "2.0000", - "samples_count": 2 - }, - { - "resource": { - "type": "url", - "name": "/", - "id": 16 - }, - "metric_count": 2, - "val": 2, - "min": "1.0000", - "max": "1.0000", - "sum": "2.0000", - "samples_count": 2 - }, - { - "resource": { - "type": "url", - "name": "/documents/", - "id": 21 - }, - "metric_count": 1, - "val": 1, - "min": "1.0000", - "max": "1.0000", - "sum": "1.0000", - "samples_count": 1 - } - ], - "valid_to": "2018-07-12T15:39:25.126Z" - } - ], - "metric": "request.users", - "interval": 86400.0, - "type": "value", - "axis_label": "Count", - "label": null - } - } - -3. total number of unique sessions per event_type: for example total number of unique visits of resource pages (indipendently by resource type and id) - - * to get number of requests - - ``GET /monitoring/api/metric_data/request.users/?`` - ``last=86400&interval=86400&group_by=event_type`` - - * to get number of unique tracking ids - - ``GET /monitoring/api/metric_data/request.users/?`` - ``last=86400&interval=86400&group_by=event_type_on_label`` - - * to get number of unique tracking ids for each event_type on a given resource type - - ``GET /monitoring/api/metric_data/request.users/?`` - ``last=86400&interval=86400&group_by=event_type_on_label&resource_type=url`` - - .. code-block:: json - - { - "data": { - "input_valid_from": "2018-07-11T17:54:41.467Z", - "input_valid_to": "2018-07-12T17:54:41.467Z", - "data": [ - { - "valid_from": "2018-07-11T17:54:41.467Z", - "data": [ - { - "samples_count": 5, - "event_type": "all", - "val": 2, - "min": "1.0000", - "max": "1.0000", - "sum": "5.0000", - "metric_count": 5 - }, - { - "samples_count": 5, - "event_type": "other", - "val": 2, - "min": "1.0000", - "max": "1.0000", - "sum": "5.0000", - "metric_count": 5 - }, - { - "samples_count": 5, - "event_type": "view", - "val": 2, - "min": "1.0000", - "max": "1.0000", - "sum": "5.0000", - "metric_count": 5 - } - ], - "valid_to": "2018-07-12T17:54:41.467Z" - } - ], - "metric": "request.users", - "interval": 86400.0, - "type": "value", - "axis_label": "Count", - "label": null - } - } - - * to get number of unique users for each event type on specific resource type - - ``GET /monitoring/api/metric_data/request.users/?`` - ``last=86400&interval=86400&group_by=event_type_on_user&resource_type=url`` - - .. code-block:: json - - { - "data": { - "input_valid_from": "2018-07-11T17:54:41.467Z", - "input_valid_to": "2018-07-12T17:54:41.467Z", - "data": [ - { - "valid_from": "2018-07-11T17:54:41.467Z", - "data": [ - { - "samples_count": 5, - "event_type": "all", - "val": 2, - "min": "1.0000", - "max": "1.0000", - "sum": "5.0000", - "metric_count": 5 - }, - { - "samples_count": 5, - "event_type": "other", - "val": 1, - "min": "1.0000", - "max": "1.0000", - "sum": "5.0000", - "metric_count": 5 - }, - { - "samples_count": 5, - "event_type": "view", - "val": 1, - "min": "1.0000", - "max": "1.0000", - "sum": "5.0000", - "metric_count": 5 - } - ], - "valid_to": "2018-07-12T17:54:41.467Z" - } - ], - "metric": "request.users", - "interval": 86400.0, - "type": "value", - "axis_label": "Count", - "label": null - } - } - -4. total number of unique sessions per event_type and single resource: let me see what was the most visited map page in this day, or what was the most downloaded document, what was the most requested ows layer, etc. - - * list of most visited resources of `url` type - - ``GET /monitoring/api/metric_data/request.users/?`` - ``last=86400&interval=86400&group_by=resource_on_label&resource_type=url`` - - * list of unique tracking ids for each resource (can be narrowed down to specific resource type with `resource_type` values). - - ``GET /monitoring/api/metric_data/request.users/?`` - ``last=86400&interval=86400&group_by=resource_on_label`` - - .. code-block:: json - - { - "data": { - "input_valid_from": "2018-07-11T17:56:49.381Z", - "input_valid_to": "2018-07-12T17:56:49.381Z", - "data": [ - { - "valid_from": "2018-07-11T17:56:49.381Z", - "data": [ - { - "resource": { - "type": "", - "name": "", - "id": 1 - }, - "metric_count": 16, - "val": 9, - "min": "0.0000", - "max": "24.0000", - "sum": "82.0000", - "samples_count": 82 - }, - { - "resource": { - "type": "layer", - "name": "geonode:ne_50m_admin_0_countries_lakes", - "id": 2 - }, - "metric_count": 4, - "val": 3, - "min": "0.0000", - "max": "2.0000", - "sum": "3.0000", - "samples_count": 3 - }, - { - "resource": { - "type": "layer", - "name": "geonode:world_iso2", - "id": 12 - }, - "metric_count": 4, - "val": 2, - "min": "0.0000", - "max": "5.0000", - "sum": "8.0000", - "samples_count": 8 - }, - { - "resource": { - "type": "url", - "name": "/layers/", - "id": 15 - }, - "metric_count": 2, - "val": 2, - "min": "1.0000", - "max": "1.0000", - "sum": "2.0000", - "samples_count": 2 - }, - { - "resource": { - "type": "url", - "name": "/", - "id": 16 - }, - "metric_count": 2, - "val": 2, - "min": "1.0000", - "max": "1.0000", - "sum": "2.0000", - "samples_count": 2 - }, - { - "resource": { - "type": "url", - "name": "/documents/", - "id": 21 - }, - "metric_count": 1, - "val": 1, - "min": "1.0000", - "max": "1.0000", - "sum": "1.0000", - "samples_count": 1 - }, - { - "resource": { - "type": "document", - "name": "GeoServer Configuration.pdf", - "id": 22 - }, - "metric_count": 1, - "val": 1, - "min": "5.0000", - "max": "5.0000", - "sum": "5.0000", - "samples_count": 5 - } - ], - "valid_to": "2018-07-12T17:56:49.381Z" - } - ], - "metric": "request.users", - "interval": 86400.0, - "type": "value", - "axis_label": "Count", - "label": null - } - } - -5. total number of unique visitor (user) per event_type and single resource: let me see how many users visited the map page in this day, or how many users download some resource, etc. - - * number of unique visitors (users) in a year for a given event_type: - - ``GET /monitoring/api/metric_data/request.users/`` - ``?valid_from=2019-01-01+00:00:00&valid_to=2019-12-31+23:59:59`` - ``&interval=31536000&event_type=upload&group_by=user`` - - * number of unique visitors (users) in a given time interval and for a given resource_type. - - ``GET /monitoring/api/metric_data/request.users/`` - ``?valid_from=2019-01-01+00:00:00&valid_to=2019-12-31+23:59:59`` - ``&interval=31536000&resource_type=layer&group_by=user`` - - the responses should look like this: - - .. code-block:: json - - { - "data": { - "input_valid_from": "2019-01-01T00:00:00Z", - "input_valid_to": "2019-12-31T23:59:59Z", - "data": [ - { - "valid_from": "2019-01-01T00:00:00Z", - "data": [ - { - "samples_count": 3, - "val": 2, - "min": "1.0000", - "max": "2.0000", - "sum": "3.0000", - "metric_count": 2 - } - ], - "valid_to": "2020-01-01T00:00:00Z" - } - ], - "metric": "request.users", - "interval": 31536000, - "type": "value", - "axis_label": "Count", - "label": null - } - } - -6. total number of unique tracking ids/sessions for a given user. - - * sessions count for anonymous users: - - ``GET /monitoring/api/metric_data/request.users/`` - ``?valid_from=2019-01-01+00:00:00&valid_to=2019-12-31+23:59:59`` - ``&interval=31536000&group_by=label&user=AnonymousUser`` - - .. code-block:: json - - { - "data": { - "input_valid_from": "2019-01-01T00:00:00Z", - "input_valid_to": "2019-12-31T23:59:59Z", - "data": [ - { - "valid_from": "2019-01-01T00:00:00Z", - "data": [ - { - "samples_count": 5, - "val": 5, - "min": "1.0000", - "max": "1.0000", - "sum": "5.0000", - "metric_count": 5 - } - ], - "valid_to": "2020-01-01T00:00:00Z" - } - ], - "metric": "request.users", - "interval": 31536000, - "type": "value", - "axis_label": "Count", - "label": null - } - } - -7. total number of unique tracking ids/sessions for each user. - - * sessions count for each users: - - ``GET /monitoring/api/metric_data/request.users/`` - ``?valid_from=2019-01-01+00:00:00&valid_to=2019-12-31+23:59:59`` - ``&interval=31536000&group_by=user_on_label`` - - .. code-block:: json - - { - "data": { - "input_valid_from": "2019-01-01T00:00:00Z", - "input_valid_to": "2019-12-31T23:59:59Z", - "data": [ - { - "valid_from": "2019-01-01T00:00:00Z", - "data": [ - { - "samples_count": 5, - "val": 5, - "min": "1.0000", - "max": "1.0000", - "sum": "5.0000", - "user": "AnonymousUser", - "metric_count": 5 - }, - { - "samples_count": 16, - "val": 3, - "min": "1.0000", - "max": "2.0000", - "sum": "16.0000", - "user": "admin", - "metric_count": 14 - }, - { - "samples_count": 4, - "val": 1, - "min": "1.0000", - "max": "1.0000", - "sum": "4.0000", - "user": "user1_username", - "metric_count": 4 - } - ], - "valid_to": "2020-01-01T00:00:00Z" - } - ], - "metric": "request.users", - "interval": 31536000, - "type": "value", - "axis_label": "Count", - "label": null - } - } - - * sessions count for each users which do something with a layer: - - ``GET /monitoring/api/metric_data/request.users/`` - ``?valid_from=2019-01-01+00:00:00&valid_to=2019-12-31+23:59:59`` - ``&interval=31536000&resource_type=layer&group_by=user_on_label`` - - .. code-block:: json - - { - "data": { - "input_valid_from": "2019-01-01T00:00:00Z", - "input_valid_to": "2019-12-31T23:59:59Z", - "data": [ - { - "valid_from": "2019-01-01T00:00:00Z", - "data": [ - { - "samples_count": 2, - "val": 1, - "min": "2.0000", - "max": "2.0000", - "sum": "2.0000", - "user": "admin", - "metric_count": 1 - }, - { - "samples_count": 1, - "val": 1, - "min": "1.0000", - "max": "1.0000", - "sum": "1.0000", - "user": "user1_username", - "metric_count": 1 - } - ], - "valid_to": "2020-01-01T00:00:00Z" - } - ], - "metric": "request.users", - "interval": 31536000, - "type": "value", - "axis_label": "Count", - "label": null - } - } - -8. total number of unique users for each monitored resource. - - ``GET /monitoring/api/metric_data/request.users/`` - ``?last=31536000&interval=31536000&group_by=resource_on_user`` - - .. code-block:: json - - { - "data": { - "input_valid_from": "2018-09-10T14:15:39.454Z", - "input_valid_to": "2019-09-10T14:15:39.454Z", - "data": [ - { - "valid_from": "2018-09-10T14:15:39.454Z", - "data": [ - { - "resource": { - "href": "/", - "type": "url", - "name": "/", - "id": 1 - }, - "metric_count": 36, - "val": 4, - "max": "2.0000", - "sum": "35.0000", - "min": "0.0000", - "samples_count": 35 - }, - { - "resource": { - "href": "/maps/", - "type": "url", - "name": "/maps/", - "id": 3 - }, - "metric_count": 3, - "val": 2, - "max": "1.0000", - "sum": "3.0000", - "min": "1.0000", - "samples_count": 3 - }, - { - "resource": { - "href": "", - "type": "layer", - "name": "geonode:railways", - "id": 4 - }, - "metric_count": 5, - "val": 2, - "max": "2.0000", - "sum": "3.0000", - "min": "0.0000", - "samples_count": 3 - }, - { - "resource": { - "href": "/layers/", - "type": "url", - "name": "/layers/", - "id": 2 - }, - "metric_count": 4, - "val": 1, - "max": "1.0000", - "sum": "4.0000", - "min": "1.0000", - "samples_count": 4 - }, - { - "resource": { - "href": "/documents/2", - "type": "document", - "name": "test_doc_1.txt", - "id": 5 - }, - "metric_count": 2, - "val": 1, - "max": "2.0000", - "sum": "4.0000", - "min": "2.0000", - "samples_count": 4 - }, - { - "resource": { - "href": "/maps/3", - "type": "map", - "name": "test_map", - "id": 6 - }, - "metric_count": 1, - "val": 1, - "max": "1.0000", - "sum": "1.0000", - "min": "1.0000", - "samples_count": 1 - }, - { - "resource": { - "href": "", - "type": "layer", - "name": "geonode:waterways", - "id": 7 - }, - "metric_count": 2, - "val": 1, - "max": "2.0000", - "sum": "2.0000", - "min": "0.0000", - "samples_count": 2 - } - ], - "valid_to": "2019-09-10T14:15:39.454Z" - } - ], - "metric": "request.users", - "interval": 31536000, - "type": "value", - "axis_label": "Count", - "label": null - } - } - -9. total number of resource monitored in a given time range. - - ``GET /monitoring/api/metric_data/request.users/`` - ``?last=31536000&interval=31536000&group_by=count_on_resource`` - - .. code-block:: json - - { - "data": { - "input_valid_from": "2018-09-10T14:20:27.335Z", - "input_valid_to": "2019-09-10T14:20:27.335Z", - "data": [ - { - "valid_from": "2018-09-10T14:20:27.335Z", - "data": [ - { - "samples_count": 52, - "val": 7, - "min": "0.0000", - "max": "2.0000", - "sum": "52.0000", - "metric_count": 53 - } - ], - "valid_to": "2019-09-10T14:20:27.335Z" - } - ], - "metric": "request.users", - "interval": 31536000, - "type": "value", - "axis_label": "Count", - "label": null - } - } diff --git a/docs/intermediate/viewer/index.rst b/docs/intermediate/viewer/index.rst deleted file mode 100644 index fc2a5319048..00000000000 --- a/docs/intermediate/viewer/index.rst +++ /dev/null @@ -1,8 +0,0 @@ -GXP -=== - -MapStore 2 -========== - -Leaflet -======= \ No newline at end of file diff --git a/docs/make.bat b/docs/make.bat deleted file mode 100644 index 5cc0ab8569f..00000000000 --- a/docs/make.bat +++ /dev/null @@ -1,184 +0,0 @@ -@ECHO OFF - -REM Command file for Sphinx documentation - -if "%SPHINXBUILD%" == "" ( - set SPHINXBUILD=sphinx-build -) - -set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . -set LANG= -if NOT "%2" == "" ( - set LANG=%2 -) - -if NOT "%LANG%" == "" ( - set ALLSPHINXOPTS=-D language=%LANG% %ALLSPHINXOPTS% - set BUILDDIR=_build/%LANG% -) -if "%LANG%" == "" ( - set BUILDDIR=_build -) - -if NOT "%PAPER%" == "" ( - set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% -) - -if "%1" == "" goto help - -if "%1" == "help" ( - :help - echo.Please use `make ^` where ^ is one of - echo. html to make standalone HTML files - echo. dirhtml to make HTML files named index.html in directories - echo. singlehtml to make a single large HTML file - echo. pickle to make pickle files - echo. json to make JSON files - echo. htmlhelp to make HTML files and a HTML help project - echo. qthelp to make HTML files and a qthelp project - echo. devhelp to make HTML files and a Devhelp project - echo. epub to make an epub - echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter - echo. text to make text files - echo. man to make manual pages - echo. changes to make an overview over all changed/added/deprecated items - echo. linkcheck to check all external links for integrity - echo. doctest to run all doctests embedded in the documentation if enabled - goto end -) - -if "%1" == "clean" ( - for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i - del /q /s %BUILDDIR%\* - goto end -) - -if "%1" == "html" ( - rem echo %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html - %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The HTML pages are in %BUILDDIR%/html. - goto end -) - -if "%1" == "dirhtml" ( - %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. - goto end -) - -if "%1" == "singlehtml" ( - %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. - goto end -) - -if "%1" == "pickle" ( - %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; now you can process the pickle files. - goto end -) - -if "%1" == "json" ( - %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; now you can process the JSON files. - goto end -) - -if "%1" == "htmlhelp" ( - %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; now you can run HTML Help Workshop with the ^ -.hhp project file in %BUILDDIR%/htmlhelp. - goto end -) - -if "%1" == "qthelp" ( - %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; now you can run "qcollectiongenerator" with the ^ -.qhcp project file in %BUILDDIR%/qthelp, like this: - echo.^> qcollectiongenerator %BUILDDIR%\qthelp\GeoNode.qhcp - echo.To view the help file: - echo.^> assistant -collectionFile %BUILDDIR%\qthelp\GeoNode.ghc - goto end -) - -if "%1" == "devhelp" ( - %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. - goto end -) - -if "%1" == "epub" ( - %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The epub file is in %BUILDDIR%/epub. - goto end -) - -if "%1" == "latex" ( - %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. - goto end -) - -if "%1" == "text" ( - %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The text files are in %BUILDDIR%/text. - goto end -) - -if "%1" == "man" ( - %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The manual pages are in %BUILDDIR%/man. - goto end -) - -if "%1" == "changes" ( - %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes - if errorlevel 1 exit /b 1 - echo. - echo.The overview file is in %BUILDDIR%/changes. - goto end -) - -if "%1" == "linkcheck" ( - %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck - if errorlevel 1 exit /b 1 - echo. - echo.Link check complete; look for any errors in the above output ^ -or in %BUILDDIR%/linkcheck/output.txt. - goto end -) - -if "%1" == "doctest" ( - %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest - if errorlevel 1 exit /b 1 - echo. - echo.Testing of doctests in the sources finished, look at the ^ -results in %BUILDDIR%/doctest/output.txt. - goto end -) - -:end diff --git a/docs/start/img/geonode.png b/docs/start/img/geonode.png deleted file mode 100644 index 2419c3f26b1..00000000000 Binary files a/docs/start/img/geonode.png and /dev/null differ diff --git a/docs/start/img/gn_is_made_for.png b/docs/start/img/gn_is_made_for.png deleted file mode 100644 index 1b09eabb7fc..00000000000 Binary files a/docs/start/img/gn_is_made_for.png and /dev/null differ diff --git a/docs/start/img/gn_publication_data.png b/docs/start/img/gn_publication_data.png deleted file mode 100644 index a01cdb85121..00000000000 Binary files a/docs/start/img/gn_publication_data.png and /dev/null differ diff --git a/docs/start/img/gn_publication_data_2.png b/docs/start/img/gn_publication_data_2.png deleted file mode 100644 index f74438eb966..00000000000 Binary files a/docs/start/img/gn_publication_data_2.png and /dev/null differ diff --git a/docs/start/img/gn_simplified_architecture.png b/docs/start/img/gn_simplified_architecture.png deleted file mode 100644 index a530d4064c9..00000000000 Binary files a/docs/start/img/gn_simplified_architecture.png and /dev/null differ diff --git a/docs/start/img/ie_message.png b/docs/start/img/ie_message.png deleted file mode 100644 index c5f282bae78..00000000000 Binary files a/docs/start/img/ie_message.png and /dev/null differ diff --git a/docs/start/img/modern_ie.png b/docs/start/img/modern_ie.png deleted file mode 100644 index cc255a4636b..00000000000 Binary files a/docs/start/img/modern_ie.png and /dev/null differ diff --git a/docs/start/img/online_demo-001.png b/docs/start/img/online_demo-001.png deleted file mode 100644 index 65e79e92a60..00000000000 Binary files a/docs/start/img/online_demo-001.png and /dev/null differ diff --git a/docs/start/img/virtualbox.png b/docs/start/img/virtualbox.png deleted file mode 100644 index 28d05697073..00000000000 Binary files a/docs/start/img/virtualbox.png and /dev/null differ diff --git a/docs/start/index.rst b/docs/start/index.rst deleted file mode 100644 index 74e343a53ee..00000000000 --- a/docs/start/index.rst +++ /dev/null @@ -1,174 +0,0 @@ -.. _geonode_basics: - -GeoNode Basics -============== - - .. figure:: img/geonode.png - :align: center - -is a platform for the management and publication of geospatial data. -It brings together mature open-source software projects under an easy to use interface. - - .. figure:: img/gn_simplified_architecture.png - :align: center - - *GeoNode simplified architecture* - -*With GeoNode, non-specialized users can share data and create interactive maps.* -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - - .. figure:: img/gn_is_made_for.png - :align: center - .. figure:: img/gn_publication_data.png - :align: center - .. figure:: img/gn_publication_data_2.png - :align: center - -Geospatial data storage -^^^^^^^^^^^^^^^^^^^^^^^ - -GeoNode allows users to upload vector data (currently shapefiles, json, csv, kml and kmz) and raster data in their original projections -using a web form. - -Vector data is converted into geospatial tables on a DB, satellite imagery and other kinds of raster data are retained as GeoTIFFs. - -Special importance is given to standard metadata formats like ISO 19139:2007 / ISO 19115 metadata standards. - -As soon as the upload is finished, the user can fill the resource metadata in order to make it suddenly available through the `CSW`_ (OGC Catalogue Service) -endpoints and APIs. - -Users may also upload a metadata XML document (ISO, FGDC, and Dublin Core format) to fill key GeoNode metadata elements automatically. - -Similarly, GeoNode provides a web based styler that lets the users to change the data portrayals and preview the changes at real time. - -.. _CSW: http://www.opengeospatial.org/standards/cat - - -Data mixing, maps creation -^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Once the data has been uploaded, GeoNode lets the user search for it geographically or via keywords in order to create fancy maps. - -All the layers are automatically re-projected to web Mercator for maps display, making it possible to use different popular base layers, -like Open Street Map, Google Satellite or Bing layers. - -Once the maps are saved, it is possible to embed them in any web page or get a PDF version for printing. - -GeoNode as a building block -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -A handful of other Open Source projects extend GeoNode's functionality by tapping into the re-usability of Django applications. - -Visit our gallery to see how the community uses GeoNode: `GeoNode Projects `_. - -The development community is very supportive of new projects and contributes ideas and guidance for newcomers. - -Convinced! Where do I sign? -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The next steps are: - -1. Make a ride on the :ref:`online_demo` - -2. Follow the :ref:`quick_setup_guide` in order to play with your own local instance and access all the admin functionalities - -3. Read the documentation starting from the :doc:`user guide ` to the :doc:`admin guide ` - -4. Subscribe to the `geonode-users`_ and/or `geonode-devel`_ mailing lists to join the community. - See also the section :ref:`get_in_touch` for more info. - -Thanks for your interest! - -.. _geonode-users: https://lists.osgeo.org/mailman/listinfo/geonode-users -.. _geonode-devel: https://lists.osgeo.org/mailman/listinfo/geonode-devel - -.. _supported_browsers: - -Supported Browsers -================== - -GeoNode is known to be working on all modern web browsers. - -This list includes (but is not limited to): - -- `Google Chrome `_. -- `Apple Safari `_. -- `Mozilla Firefox `_. -- `Microsoft Edge `_. -- Microsoft Internet Explorer. - -.. note:: The vast majority of GeoNode developers prefer using Google Chrome. - -Internet Explorer -^^^^^^^^^^^^^^^^^ - -Versions of Microsoft Internet Explorer older than 10, exhibit known issues when used to browse a GeoNode site. -As such a message is displayed warning the user that they should upgrade their browser. - - .. figure:: img/ie_message.png - :align: center - - *Internet Explorer error message* - -Testing on Internet Explorer -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -When working on front end code, developers should take care to test carefully with Microsoft Internet Explorer to ensure that the features -they are working on do indeed work correctly and on this browser. -It is good practice to test on all browsers available, but the use of modern front end libraries like bootstrap and jQuery make it much -more likely code will work across browsers seamlessly. - -In order to test on Internet Explorer, developers can use the `Modern IE `_ site to download virtual machines -for use in `Oracle VM Virtual Box `_. - - .. figure:: img/modern_ie.png - :align: center - - *Testing on Internet Explorer* - -Once the VM is downloaded, follow the instructions to configure it in your VirtualBox setup. - - .. figure:: img/virtualbox.png - :align: center - - *Oracle VirtualBox admin interface* - -After the VM is setup, you can access your development instance of GeoNode by visiting the IP address of your host machine or on the bridged interface (usually 10.0.2.2) and begin your testing. - -.. _online_demo: - -Online Demo -=========== - -.. note:: **Disclaimer** we do not guarantee for any data published on this Demo Site. Publish the data at your own risk. - Every dataset will be removed automatically every Sunday. If you find some dataset that shouldn't be there, please - write suddenly to developers and maintainers. - - See the section :ref:`get_in_touch` for details. - -A live demo of the latest stable build is available at http://master.demo.geonode.org/. - - .. figure:: img/online_demo-001.png - :align: center - - *Online Demo @ master.demo.geonode.org* - -Anyone may sign up for a user account, upload and style data, create and share maps, and change permissions. - -Since it is a demo site, every sunday all the datasets will be wiped out. Users, passwords and groups will be preserved. - -It should hopefully allow you to easily and quickly make a tour of the main capabilities of GeoNode. - -.. warning:: This GeoNode instance is configured with standards settings and a very low security level. - This is a demo only not to be considered a really production ready system. - For a complete list of settings, refer to the section: :ref:`settings` - -.. _quick_setup_guide: - -Quick Installation Guide -======================== - -.. toctree:: - :maxdepth: 3 - - quick/index diff --git a/docs/start/quick/img/docker.png b/docs/start/quick/img/docker.png deleted file mode 100644 index 520ac62e830..00000000000 Binary files a/docs/start/quick/img/docker.png and /dev/null differ diff --git a/docs/start/quick/img/osgeo_live.png b/docs/start/quick/img/osgeo_live.png deleted file mode 100644 index 0d7ac011fbc..00000000000 Binary files a/docs/start/quick/img/osgeo_live.png and /dev/null differ diff --git a/docs/start/quick/index.rst b/docs/start/quick/index.rst deleted file mode 100644 index 83a42757368..00000000000 --- a/docs/start/quick/index.rst +++ /dev/null @@ -1,91 +0,0 @@ -Quick Installation Guide -======================== - -Introduction -^^^^^^^^^^^^ - -The following is a quick guide to get started with GeoNode in most common operating systems. - -.. note:: For a full setup and deployment, please refer to the :doc:`complete installation guides ` - -This is meant to be run on a fresh machine with no previously installed packages or GeoNode versions. - -.. warning:: The methods presented here are meant to be used for a limited internal demo only. - Before exposing your GeoNode instance to a public server, please read carefully the :doc:`hardening guide ` - -Recommended Minimum System Requirements -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -A definite specification of technical requirements is difficult to recommend. Accepted performance is highly subjective. Furthermore, the performance depends on factors such as concurrent users, records in the database or the network connectivity of your infrastructure. - -For deployment of GeoNode on a single server, the following are the *bare minimum* system requirements: - -* 8GB of RAM. -* 2.2GHz processor with 2 cores. (Additional processing power may be required for multiple concurrent styling renderings) -* 10 GB software disk usage. -* Additional disk space for any data hosted with GeoNode and tiles cached with GeoWebCache. - For spatial data, cached tiles, and "scratch space" useful for administration, a decent baseline size for GeoNode deployments is between 50GB and 100GB. -* 64-bit hardware **strongly** recommended. - -OSGEO Live CD -^^^^^^^^^^^^^ - - .. figure:: img/osgeo_live.png - :align: center - -`OSGeoLive `_ is a self-contained bootable DVD, USB thumb drive or Virtual Machine based on Lubuntu, -that allows you to try a wide variety of open source geospatial software without installing anything. - -It is composed entirely of free software, allowing it to be freely distributed, duplicated and passed around. - -It provides pre-configured applications for a range of geospatial use cases, including storage, publishing, viewing, analysis and -manipulation of data. - -It also contains sample datasets and documentation. - -To try out the applications, simply: - -* Insert DVD or USB thumb drive in computer or virtual machine. -* Reboot computer. (verify boot device order if necessary) -* Press :guilabel:`Enter` to startup & login. -* Select and run applications from the :guilabel:`Geospatial` menu. - -`OSGeoLive `_ is an `OSGeo Foundation `_ project. -The `OSGeo Foundation `_ is a not-for-profit supporting Geospatial Open Source Software development, promotion and `education `_. - -Install via Ansible -^^^^^^^^^^^^^^^^^^^ - -`Ansible `__ is an open source automation tool for server configuration and management. It works by organizing your server inventory into groups, describes how those groups should be configured or what actions should be taken on them. We can use ansible for installing GeoNode-project on one or many servers. - -* :ref:`Manual installation of geonode-project ` by use of Ansible - - -Install via Docker -^^^^^^^^^^^^^^^^^^ - -`Docker `_ is a free software platform used for packaging software into standardized units for development, shipment and deployment. - - .. figure:: img/docker.png - .. note:: credits to Docker - -Introducing main concepts -......................... - -A container image is a lightweight, stand-alone, executable package of a piece of software that includes everything needed to run it: code, runtime, system tools, system libraries, settings. - -Docker containers running on a single machine share that machine's operating system kernel; they start instantly and use less compute and RAM. - -Containers can share a single kernel, and the only information that needs to be in a container image is the executable and its package dependencies, which never need to be installed on the host system. - -Multiple containers can run on the same machine and share the OS kernel with other containers, each running as isolated processes in user space. - -The following tutorials will introduce the use of Docker community edition on: - -* :doc:`Ubuntu 18.04 ` - -* :doc:`CentOS 7.0 ` - -GeoNode provides also an advanced stack of Docker containers for a more stable, production-like setup: - -* :doc:`SPCGeoNode ` diff --git a/docs/usage/accounts_user_profile/index.rst b/docs/usage/accounts_user_profile/index.rst deleted file mode 100644 index 5acb5916676..00000000000 --- a/docs/usage/accounts_user_profile/index.rst +++ /dev/null @@ -1,15 +0,0 @@ -Accounts and User Profile -========================= - -In GeoNode many contents are public so unregistered users have read-only access to public maps, layers and documents. -In order to create maps, add layers or documents, edit the data and share these resources with other users, you need to sign in. - -GeoNode is primarily a *social* platform, thus a primary component of any GeoNode instance is the user account. - -This section will guide you through account registration, updating your account information and preferences, connections with social networks and email addresses. - -.. toctree:: - :maxdepth: 1 - - new_account/index - updating_profile/index diff --git a/docs/usage/accounts_user_profile/new_account/img/confirm_logout.png b/docs/usage/accounts_user_profile/new_account/img/confirm_logout.png deleted file mode 100644 index de837ae5e08..00000000000 Binary files a/docs/usage/accounts_user_profile/new_account/img/confirm_logout.png and /dev/null differ diff --git a/docs/usage/accounts_user_profile/new_account/img/logout_link.png b/docs/usage/accounts_user_profile/new_account/img/logout_link.png deleted file mode 100644 index c0afcd036a6..00000000000 Binary files a/docs/usage/accounts_user_profile/new_account/img/logout_link.png and /dev/null differ diff --git a/docs/usage/accounts_user_profile/new_account/img/register_alerts.png b/docs/usage/accounts_user_profile/new_account/img/register_alerts.png deleted file mode 100644 index 1f4069b6f00..00000000000 Binary files a/docs/usage/accounts_user_profile/new_account/img/register_alerts.png and /dev/null differ diff --git a/docs/usage/accounts_user_profile/new_account/img/register_button.png b/docs/usage/accounts_user_profile/new_account/img/register_button.png deleted file mode 100644 index f7fd061736d..00000000000 Binary files a/docs/usage/accounts_user_profile/new_account/img/register_button.png and /dev/null differ diff --git a/docs/usage/accounts_user_profile/new_account/img/register_form.png b/docs/usage/accounts_user_profile/new_account/img/register_form.png deleted file mode 100644 index e69c29a5fbd..00000000000 Binary files a/docs/usage/accounts_user_profile/new_account/img/register_form.png and /dev/null differ diff --git a/docs/usage/accounts_user_profile/new_account/index.rst b/docs/usage/accounts_user_profile/new_account/index.rst deleted file mode 100644 index a17aba9bfd6..00000000000 --- a/docs/usage/accounts_user_profile/new_account/index.rst +++ /dev/null @@ -1,41 +0,0 @@ -Creating a New Account -====================== - -To take full advantage of all the GeoNode features you need an user account. Follow these step to create a new one. - -#. From any page in the web interface, you will see a :guilabel:`Register` link. Click that link, and the register form will appear - - .. note:: The registrations in GeoNode must be open, in case you don't see the register link then it's not possible to register unless the administrator of the site does that for you. - - .. figure:: img/register_button.png - :align: center - - *Sign in screen* - -#. On the next page, fill out the form. Enter a user name and password in the fields. Also, enter your email address for verification. - - .. figure:: img/register_form.png - :align: center - - *Registering for a new account* - -#. You will be automatically logged in and redirected to the Profile page. An email will be sent confirming that you have signed up. If no errors occur during the registration, the following alerts will appear on the screen: - - .. figure:: img/register_alerts.png - :align: center - - *Alerts* - -To logout click on the :guilabel:`Log out` link of the user menu. - -.. figure:: img/logout_link.png - :align: center - - *Logout link* - -You have to confirm this action as described in the picture below. - - .. figure:: img/confirm_logout.png - :align: center - - *Confirm Log out* diff --git a/docs/usage/accounts_user_profile/updating_profile/associating_email.rst b/docs/usage/accounts_user_profile/updating_profile/associating_email.rst deleted file mode 100644 index 2a303e6ec5c..00000000000 --- a/docs/usage/accounts_user_profile/updating_profile/associating_email.rst +++ /dev/null @@ -1,25 +0,0 @@ -.. _associating_emails: - -Associating your Account with an e-mail -======================================= - -Your account is automatically associated with the e-mail that you used to register yourself on the platform. - -.. figure:: img/associate_email.png - :align: center - - *Accounts e-mail* - -By clicking on :guilabel:`Associated e-mails` of the *Profile* page (see :ref:`editing-profile`), you will have the possibility to fill up a new e-mail address. Type it in the :guilabel:`E-mail` input filed then click on :guilabel:`Add E-mail` to perfrom a new association. - -.. figure:: img/associate_new_email.png - :align: center - - *New e-mail association* - -You can make it primary if necessary, in order to receive the notification on this address. To do that, select the e-mail that you want, then click on :guilabel:`Make Primary`. - -.. figure:: img/primary_email.png - :align: center - - *Primary e-mail address* diff --git a/docs/usage/accounts_user_profile/updating_profile/connecting_with_social.rst b/docs/usage/accounts_user_profile/updating_profile/connecting_with_social.rst deleted file mode 100644 index 636702194e1..00000000000 --- a/docs/usage/accounts_user_profile/updating_profile/connecting_with_social.rst +++ /dev/null @@ -1,4 +0,0 @@ -Connecting your Account with Social Networks -============================================ - -You currently have no social network accounts connected to this account. diff --git a/docs/usage/accounts_user_profile/updating_profile/editing_profile.rst b/docs/usage/accounts_user_profile/updating_profile/editing_profile.rst deleted file mode 100644 index cad76c336aa..00000000000 --- a/docs/usage/accounts_user_profile/updating_profile/editing_profile.rst +++ /dev/null @@ -1,19 +0,0 @@ -Editing Profile Information -=========================== - -Your *Profile* contains personal information such as your address, your telephone number, your organization and so on but it is empty by default at the beginning. - -Through the :guilabel:`Edit profile` button of the *Profile* page (see :ref:`editing-profile`) you can set your details, including your avatar. - -.. figure:: img/user_profile_update_info.png - :align: center - - *Updating Profile information* - -| When finished, click :guilabel:`Update profile`. You will be redirected to the *Profile* page. -| A message will confirm the profile has been correctly updated. - -.. figure:: img/profile_update_confirm.png - :align: center - - *Updating Profile correctly finalized* diff --git a/docs/usage/accounts_user_profile/updating_profile/img/associate_email.png b/docs/usage/accounts_user_profile/updating_profile/img/associate_email.png deleted file mode 100644 index 3ecb2523cb6..00000000000 Binary files a/docs/usage/accounts_user_profile/updating_profile/img/associate_email.png and /dev/null differ diff --git a/docs/usage/accounts_user_profile/updating_profile/img/associate_new_email.png b/docs/usage/accounts_user_profile/updating_profile/img/associate_new_email.png deleted file mode 100644 index 6921de37b36..00000000000 Binary files a/docs/usage/accounts_user_profile/updating_profile/img/associate_new_email.png and /dev/null differ diff --git a/docs/usage/accounts_user_profile/updating_profile/img/change_password.png b/docs/usage/accounts_user_profile/updating_profile/img/change_password.png deleted file mode 100644 index 46ea22bb07e..00000000000 Binary files a/docs/usage/accounts_user_profile/updating_profile/img/change_password.png and /dev/null differ diff --git a/docs/usage/accounts_user_profile/updating_profile/img/change_password_confirm.png b/docs/usage/accounts_user_profile/updating_profile/img/change_password_confirm.png deleted file mode 100644 index bb2f3e82905..00000000000 Binary files a/docs/usage/accounts_user_profile/updating_profile/img/change_password_confirm.png and /dev/null differ diff --git a/docs/usage/accounts_user_profile/updating_profile/img/favorites_resources.png b/docs/usage/accounts_user_profile/updating_profile/img/favorites_resources.png deleted file mode 100644 index aed472f3545..00000000000 Binary files a/docs/usage/accounts_user_profile/updating_profile/img/favorites_resources.png and /dev/null differ diff --git a/docs/usage/accounts_user_profile/updating_profile/img/notifications_settings.png b/docs/usage/accounts_user_profile/updating_profile/img/notifications_settings.png deleted file mode 100644 index 070c4a1a0f1..00000000000 Binary files a/docs/usage/accounts_user_profile/updating_profile/img/notifications_settings.png and /dev/null differ diff --git a/docs/usage/accounts_user_profile/updating_profile/img/primary_email.png b/docs/usage/accounts_user_profile/updating_profile/img/primary_email.png deleted file mode 100644 index bf04a6feb57..00000000000 Binary files a/docs/usage/accounts_user_profile/updating_profile/img/primary_email.png and /dev/null differ diff --git a/docs/usage/accounts_user_profile/updating_profile/img/profile_link.png b/docs/usage/accounts_user_profile/updating_profile/img/profile_link.png deleted file mode 100644 index 848151b86b4..00000000000 Binary files a/docs/usage/accounts_user_profile/updating_profile/img/profile_link.png and /dev/null differ diff --git a/docs/usage/accounts_user_profile/updating_profile/img/profile_update_confirm.png b/docs/usage/accounts_user_profile/updating_profile/img/profile_update_confirm.png deleted file mode 100644 index 9a26d45f55c..00000000000 Binary files a/docs/usage/accounts_user_profile/updating_profile/img/profile_update_confirm.png and /dev/null differ diff --git a/docs/usage/accounts_user_profile/updating_profile/img/user_activities.png b/docs/usage/accounts_user_profile/updating_profile/img/user_activities.png deleted file mode 100644 index aa732d3f179..00000000000 Binary files a/docs/usage/accounts_user_profile/updating_profile/img/user_activities.png and /dev/null differ diff --git a/docs/usage/accounts_user_profile/updating_profile/img/user_profile_page.png b/docs/usage/accounts_user_profile/updating_profile/img/user_profile_page.png deleted file mode 100644 index b1f6c5b8e1f..00000000000 Binary files a/docs/usage/accounts_user_profile/updating_profile/img/user_profile_page.png and /dev/null differ diff --git a/docs/usage/accounts_user_profile/updating_profile/img/user_profile_update_info.png b/docs/usage/accounts_user_profile/updating_profile/img/user_profile_update_info.png deleted file mode 100644 index cb4e590408c..00000000000 Binary files a/docs/usage/accounts_user_profile/updating_profile/img/user_profile_update_info.png and /dev/null differ diff --git a/docs/usage/accounts_user_profile/updating_profile/index.rst b/docs/usage/accounts_user_profile/updating_profile/index.rst deleted file mode 100644 index dcf480e9eab..00000000000 --- a/docs/usage/accounts_user_profile/updating_profile/index.rst +++ /dev/null @@ -1,58 +0,0 @@ -.. _editing-profile: - -Updating the Profile -===================== - -Once having an account you can enrich your profile with useful information, you can also edit or delete the existing ones. -You can connect the account with your social network, associate many e-mail addresses to it and manage many options such as preferences about notifications. - -You can update these information anytime from your *Profile* page, it is accessible from the user menu. - -So, click on your user name in the top right of the screen. A drop-down list will show. Click on :guilabel:`Profile` to enter the *Profile* settings page. - -.. figure:: img/profile_link.png - :align: center - - *Link to your profile* - -The *Profile* page looks like the one shown in the picture below. - -.. figure:: img/user_profile_page.png - :align: center - - *User profile page* - -Your personal information are shown under the username. At the bottom of the page are listed all the resources associated to your *Profile*, you can decide to view only layers or maps or documents by clicking on the corresponding tab. - -Through the link ``User layers WMS GetCapabilities document`` you can retrieve an XML document with the list of the available layers. - -On the right side of the page there are many useful links to edit personal information, to upload and create layers or maps, to update your *Profile* settings and to get in touch with other GeoNode users. - -The :guilabel:`Favorites` link, also accessible from the user menu, drive you to the list of the resources marked as your favorites. - -.. figure:: img/favorites_resources.png - :align: center - - *Favorites* - -Click the :guilabel:`Delete from Favorites` button to remove the resource from the list. - -The :guilabel:`My Activities` link allows to see all your recent activities on GeoNode such as layers uploading and maps creation. - -.. figure:: img/user_activities.png - :align: center - - *Recent activities* - -This link is also available in the user menu. - -All other links and their functionalities will be described in depth in the following sections. - -.. toctree:: - :maxdepth: 1 - - editing_profile - connecting_with_social - associating_email - managing_password - notification_settings diff --git a/docs/usage/accounts_user_profile/updating_profile/managing_password.rst b/docs/usage/accounts_user_profile/updating_profile/managing_password.rst deleted file mode 100644 index 0fcf9e46c3a..00000000000 --- a/docs/usage/accounts_user_profile/updating_profile/managing_password.rst +++ /dev/null @@ -1,19 +0,0 @@ -Managing the Password -===================== - -To change your password, click on the :guilabel:`Set/Change password` link of the *Profile* page (see :ref:`editing-profile`). -You will be asked to enter your current password and the new one (two times). Click on :guilabel:`Change my password` to perform the change. - -.. figure:: img/change_password.png - :align: center - - *Change your password* - -If no errors occur you will see a confirmation message. - -.. figure:: img/change_password_confirm.png - :align: center - - *Change password confirmation* - -Next time you log in you will have to use the new password. diff --git a/docs/usage/accounts_user_profile/updating_profile/notification_settings.rst b/docs/usage/accounts_user_profile/updating_profile/notification_settings.rst deleted file mode 100644 index f8985edd905..00000000000 --- a/docs/usage/accounts_user_profile/updating_profile/notification_settings.rst +++ /dev/null @@ -1,14 +0,0 @@ -Setting Notification Preferences -================================ - -By default GeoNode sends notifications to the users for events that the users could be subscribe such as a new layer uploaded or a new rate added to a map. -You can adjust your notification settings by clicking on the :guilabel:`Notifications` link of the *Profile* page (see :ref:`editing-profile`). - -.. note:: Make sure to have a verified email address to which notices can be sent. If not see :ref:`associating_emails`. - -Now check/uncheck the notification types you wish to receive or not receive. It is possible to be notified for the events shown in the picture below. - -.. figure:: img/notifications_settings.png - :align: center - - *Notifications settings* diff --git a/docs/usage/data/data_types.rst b/docs/usage/data/data_types.rst deleted file mode 100644 index ff043c8d566..00000000000 --- a/docs/usage/data/data_types.rst +++ /dev/null @@ -1,59 +0,0 @@ -.. _data-types: - -Data Types -========== - -| GeoNode welcome page shows a variety of information about the current GeoNode instance. -| You can explore the existing data using many search tools and filters (see :ref:`finding-data`) or through the links of the navigation bar at the top of the page. -| There are three main types of resources that GeoNode can manage: - -#. Documents -#. Layers -#. Maps - -Documents and layers can be accessed from the :guilabel:`Data` menu of the navigation bar. - -.. figure:: img/data_menu.png - :align: center - - *Data menu* - -The :guilabel:`Maps` menu let you to manage maps. - -.. figure:: img/maps_menu.png - :align: center - - *Maps menu* - -.. _document-data-type: - -Documents ---------- - -| GeoNode allows to publish tabular and text data and to manage metadata and associated documents. -| Documents can be uploaded directly from your disk (see :ref:`uploading-documents` for further information). -| The following documents types are allowed: `.doc, .docx, .gif, .jpg, .jpeg, .ods, .odt, .odp, .pdf, .png, .ppt, .pptx, .rar, .sld, .tif, .tiff, .txt, .xls, .xlsx, .xml, .zip, .gz, .qml`. -| Through the document detailed page is possible to view, download and manage a document. - -Layers ------- - -| Layers are a primary component of GeoNode. -| Layers are publishable resources representing a raster or vector spatial data source. Layers also can be associated with metadata, ratings, and comments. - -| By clicking the Layers link you will get a list of all published layers. If logged in as an administrator, you will also see the unpublished layers in the same list. -| GeoNode allows the user to upload vector and raster data in their original projections using a web form. - -Vector data can be uploaded in many different formats (ESRI Shapefile, KML and so on...). Satellite imagery and other kinds of raster data can be uploaded as GeoTIFFs. - -Maps ----- - -| Maps are a primary component of GeoNode. -| Maps are comprised of various layers and their styles. Layers can be both local layers in GeoNode as well as remote layers either served from other WMS servers or by web service layers such as Google or MapQuest. - -GeoNode maps also contain other information such as map zoom and extent, layer ordering, and style. - -You can create a map based on uploaded layers, combine them with some existing layers and a remote web service layer, share the resulting map for public viewing. -Once the data has been uploaded, GeoNode lets the user search for it geographically or via keywords and create maps. -All the layers are automatically reprojected to web mercator for maps display, making it possible to use popular base maps such as `OpenStreetMap `_. diff --git a/docs/usage/data/finding_data.rst b/docs/usage/data/finding_data.rst deleted file mode 100644 index 782aac33bc5..00000000000 --- a/docs/usage/data/finding_data.rst +++ /dev/null @@ -1,150 +0,0 @@ -.. _finding-data: - -Finding Data -============ - -| This section will guide you to navigate GeoNode to find layers, maps and documents by using different routes, filters and search functions. -| In *Home* page you can find some quick search tool. - -The *Search* box in the navigation bar (see the picture below) let you type a text and find all the data which have to deal with that text. - -.. figure:: img/search_tool.png - :align: center - - *Search tool in GeoNode welcome page* - -When you trigger a search you are brought to the *Search* page which shows you the search result through all data types. - -.. figure:: img/search_page.png - :align: center - - *The Search page* - -| This page contains a wealth of options for customizing a search for various information on GeoNode. This search form allows for much more fine-tuned searches than the simple search box is available at the top of every page. -| It is possible to search for data by Text, Categories, Type, Keywords, Owners, Date, Regions or Extent. - -Try to set some filter and see how the resulting data list changes accordingly. An interesting type of filter is *EXTENT*: you can apply a spatial filter by moving or zooming a map within a box as shown in the picture below. - -.. figure:: img/search_filter_by_extent.png - :align: center - - *Search filter by EXTENT* - -Data can be ordered by date, name and popularity. - -.. figure:: img/ordering_data.png - :align: center - - *Ordering Data* - -The GeoNode welcome page offers you many other options to find resources. - -* The *Search for data* tool allows you to search for data by name. - - .. figure:: img/welcome_search_data.png - :align: center - - *Searching for data* - - The *Search* page, which you will be redirected to, will have the TEXT filter already set with the name you have typed in the search box (see the picture below). - If you want to reach the *Search page* directly, without any input text, you can click the :guilabel:`Advanced Search` link. - - .. figure:: img/search_for_data_result.png - :align: center - - *Results of searching made by name* - -* In the *Home* page section shown below are listed all the categories available in the GeoNode instance you are using. You can search for data by category by clicking on it. - - .. figure:: img/search_datasets_by_category.png - :align: center - - *Searching for datasets by category* - - In the *Search* page, data will be filtered by that category. - - .. figure:: img/search_by_category_result.png - :align: center - - *Results of searching made by category* - -* | The *Featured Datasets* section (see the picture below) shows you aggregate data about *Layers*, *Maps*, *Documents* and *Users*. You can trigger a search on layers by clicking on the *Layers* icon, the same happens for *Maps*, *Documents* and *Users*. The :guilabel:`Explore all datasets` drive you to the *Search* page with no filter on data types. - | In this section there are also useful quick links to add new resources: the :guilabel:`Add layers` drives you to the layer uploading page, the :guilabel:`Add documents` to the document uploading page and the :guilabel:`Create maps` guide you to the map creation. - - .. figure:: img/featured_datasets.png - :align: center - - *Featured Datasets* - - For each data type GeoNode makes available an individual *Search* page, the next paragraphs will explain that in depth. - For *Users* see :ref:`user-info`. - -.. _finding-documents: - -Documents ---------- - -When you are searching for *Documents* you can: - -* use the *Documents* quick link of the *Featured Datasets* section as described above - -* click on the :guilabel:`Documents` link of the :guilabel:`Data` menu in the navigation bar - - .. figure:: img/documents_link.png - :align: center - - *Link for Documents* - -The *Documents* search page looks like the generic one but only *Document* is considered as data type. You can filter documents by CATEGORIES, as in the example below, or by TEXT, KEYWORDS and so on. -You can also use more than one filter at the same time. - -.. figure:: img/documents_filter_by_category.png - :align: center - - *Documents filtered by categories* - -.. _finding-layers: - -Layers ------- - -To find *Layers* you can: - -* use the *Layers* quick link of the *Featured Datasets* - -* click on the :guilabel:`Layers` link of the :guilabel:`Data` menu in the navigation bar - - .. figure:: img/layers_link.png - :align: center - - *Link for Layers* - -| In the *Layers* search page only *Layer* will be considered as data type. You can set one or more filter to refine the search. In the example below the layers have been filtered by EXTENT and CATEGORIES. - -.. figure:: img/filtering_layers.gif - :align: center - - *Layers filtered by extent* - -.. _finding-maps: - -Maps ----- - -If you are searching for *Maps* you can: - -* use the *Maps* quick link of the *Featured Datasets* section as described above - -* click on the :guilabel:`Explore Maps` link of the :guilabel:`Maps` menu in the navigation bar - - .. figure:: img/maps_link.png - :align: center - - *Link for Maps* - -As seen for the other data types, the *Maps* search page allows you to filter your maps by a combination of criteria. The example below shows maps filtered by REGIONS. - -.. figure:: img/filtering_maps.gif - :align: center - - *Maps filtered by regions* diff --git a/docs/usage/data/img/data_menu.png b/docs/usage/data/img/data_menu.png deleted file mode 100644 index 86ad001e683..00000000000 Binary files a/docs/usage/data/img/data_menu.png and /dev/null differ diff --git a/docs/usage/data/img/documents_filter_by_category.png b/docs/usage/data/img/documents_filter_by_category.png deleted file mode 100644 index 672ef330c5b..00000000000 Binary files a/docs/usage/data/img/documents_filter_by_category.png and /dev/null differ diff --git a/docs/usage/data/img/documents_link.png b/docs/usage/data/img/documents_link.png deleted file mode 100644 index ec227892753..00000000000 Binary files a/docs/usage/data/img/documents_link.png and /dev/null differ diff --git a/docs/usage/data/img/featured_datasets.png b/docs/usage/data/img/featured_datasets.png deleted file mode 100644 index 61cea84715f..00000000000 Binary files a/docs/usage/data/img/featured_datasets.png and /dev/null differ diff --git a/docs/usage/data/img/filtering_layers.gif b/docs/usage/data/img/filtering_layers.gif deleted file mode 100644 index 8c868bbec7a..00000000000 Binary files a/docs/usage/data/img/filtering_layers.gif and /dev/null differ diff --git a/docs/usage/data/img/filtering_maps.gif b/docs/usage/data/img/filtering_maps.gif deleted file mode 100644 index 3dc35074424..00000000000 Binary files a/docs/usage/data/img/filtering_maps.gif and /dev/null differ diff --git a/docs/usage/data/img/layers_link.png b/docs/usage/data/img/layers_link.png deleted file mode 100644 index e1427db69fb..00000000000 Binary files a/docs/usage/data/img/layers_link.png and /dev/null differ diff --git a/docs/usage/data/img/maps_link.png b/docs/usage/data/img/maps_link.png deleted file mode 100644 index a75740be853..00000000000 Binary files a/docs/usage/data/img/maps_link.png and /dev/null differ diff --git a/docs/usage/data/img/maps_menu.png b/docs/usage/data/img/maps_menu.png deleted file mode 100644 index 1b18773b905..00000000000 Binary files a/docs/usage/data/img/maps_menu.png and /dev/null differ diff --git a/docs/usage/data/img/ordering_data.png b/docs/usage/data/img/ordering_data.png deleted file mode 100644 index 4ae89d32b39..00000000000 Binary files a/docs/usage/data/img/ordering_data.png and /dev/null differ diff --git a/docs/usage/data/img/search_by_category_result.png b/docs/usage/data/img/search_by_category_result.png deleted file mode 100644 index 1cd1564c772..00000000000 Binary files a/docs/usage/data/img/search_by_category_result.png and /dev/null differ diff --git a/docs/usage/data/img/search_datasets_by_category.png b/docs/usage/data/img/search_datasets_by_category.png deleted file mode 100644 index 8774188f9e4..00000000000 Binary files a/docs/usage/data/img/search_datasets_by_category.png and /dev/null differ diff --git a/docs/usage/data/img/search_filter_by_extent.png b/docs/usage/data/img/search_filter_by_extent.png deleted file mode 100644 index 635ab16165a..00000000000 Binary files a/docs/usage/data/img/search_filter_by_extent.png and /dev/null differ diff --git a/docs/usage/data/img/search_for_data_result.png b/docs/usage/data/img/search_for_data_result.png deleted file mode 100644 index 5ff10facccc..00000000000 Binary files a/docs/usage/data/img/search_for_data_result.png and /dev/null differ diff --git a/docs/usage/data/img/search_page.png b/docs/usage/data/img/search_page.png deleted file mode 100644 index b8f9757d81f..00000000000 Binary files a/docs/usage/data/img/search_page.png and /dev/null differ diff --git a/docs/usage/data/img/search_tool.png b/docs/usage/data/img/search_tool.png deleted file mode 100644 index d8ba5054641..00000000000 Binary files a/docs/usage/data/img/search_tool.png and /dev/null differ diff --git a/docs/usage/data/img/welcome_search_data.png b/docs/usage/data/img/welcome_search_data.png deleted file mode 100644 index 6416d40b19b..00000000000 Binary files a/docs/usage/data/img/welcome_search_data.png and /dev/null differ diff --git a/docs/usage/data/index.rst b/docs/usage/data/index.rst deleted file mode 100644 index 6cd03521697..00000000000 --- a/docs/usage/data/index.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. _data: - -Data -==== - -Data management tools built into GeoNode allow for integrated creation of data, documents, link to external documents, and map visualizations. -Each dataset in the system can be shared publicly or restricted to allow access to only specific users. -Social features like user profiles and commenting and rating systems allow for the development of communities around each platform to facilitate the use, management, and quality control of the data the GeoNode instance contains. - -The following sections will explain more in depth what data can be managed in GeoNode and how to easily find that data. - -.. toctree:: - :maxdepth: 1 - - data_types - finding_data diff --git a/docs/usage/index.rst b/docs/usage/index.rst deleted file mode 100644 index d82b61016e0..00000000000 --- a/docs/usage/index.rst +++ /dev/null @@ -1,14 +0,0 @@ -GeoNode Users Guide -=================== - -.. toctree:: - :maxdepth: 2 - - accounts_user_profile/index - users_groups/index - data/index - managing_documents/index - managing_layers/index - managing_maps/index - publishing_data/index - other_apps/index diff --git a/docs/usage/managing_documents/document_editing.rst b/docs/usage/managing_documents/document_editing.rst deleted file mode 100644 index 44f85148b16..00000000000 --- a/docs/usage/managing_documents/document_editing.rst +++ /dev/null @@ -1,59 +0,0 @@ -.. _document-editing: - -Document Editing -================ - -The :ref:`document-info` page makes available useful tools for document editing. Click on the :guilabel:`Edit Document` button to see what you can do to make changes. The picture below shows you the *Editing Panel* that will appear on the screen. - -.. figure:: img/document_editing_panel.png - :align: center - - *Document Editing panel* - -You can *Replace* the document file with another one by clicking on :guilabel:`Replace`. It will drive you to the *Document Upload* page (see :ref:`uploading-documents`) where you can upload a new file. - -The :guilabel:`Remove` button allows you to delete the document. You will have to confirm that choice. - -.. figure:: img/confirm_document_removal.png - :align: center - - *Document Removal confirmation* - -The *Editing Panel* shows you also some links for editing the metadata and the thumbnail. These actions will be explained more in depth in the next paragraphs. - -Setting the Document Thumbnail ------------------------------- - -From the *Editing Panel*, it is also possible to *Set the Thumbnail* of the document. Click on :guilabel:`Set` to open the *Thumbnail Uploading* page and chose the image that will illustrate your document. You can either drag and drop it in the *Drop files here* box or selecting from your folders by clicking on *Choose Files*. Once this is done, click on the red button :guilabel:`Upload files`. If the thumbnail has been successfully uploaded you can see it by coming back to the document list. Click on the :guilabel:`Explore Documents` button to check that. - -.. figure:: img/document_uploading_thumbnail.png - :align: center - - *Upload Document's Thumbnail* - -If no errors occur the following message will be shown. - -.. figure:: img/document_uploading_thumbnail_success.png - :align: center - - *Uploading success* - -Editing the Document Metadata ------------------------------ - -You can edit the metadata of your document through the buttons shown in the red rectangle in below picture. - -.. figure:: img/document_metadata_editing_buttons.png - :align: center - - *Editing Metadata* - -| The :guilabel:`Wizard` button drive you to the wizard described in the :ref:`document-metadata` section. The :guilabel:`Advanced Edit` button takes you to a big form where all the available metadata of the document can be edited. -| Some information are mandatory such as the *Title* or the *Category* the document belongs to, some others are optional. - -.. figure:: img/document_metadata_editing.png - :align: center - - *Editing Metadata* - -In the example shown in the picture above, the information inside the red rectangles have been changed. To save the changes click on :guilabel:`Update`, you will be redirected to the document page. diff --git a/docs/usage/managing_documents/document_info.rst b/docs/usage/managing_documents/document_info.rst deleted file mode 100644 index 558879f95c4..00000000000 --- a/docs/usage/managing_documents/document_info.rst +++ /dev/null @@ -1,109 +0,0 @@ -.. _document-info: - -Document Information -==================== - -From the *Documents Search Page* (see :ref:`finding-documents`) you can select the document you are interested in and see some basic information about it. You can access the document details page by clicking on its name. -That page looks like the one shown in the picture below. - -.. figure:: img/document_info.png - :align: center - - *Document Information page* - -On the page of a document, the resource is either directly displayed on the page or accessible by clicking on the link provided under the title. - -Exploring the Tabs Sections ---------------------------- - -There is a *Tab Section* below the document, where you can first view *Info* about the document. - -The **Info Tab** section shows the document metadata such as its title, abstract, date of publication etc. The metadata also indicates the user who is responsible for uploading and managing this content, as well as the group to which it is linked. - -The **Share Tab** provides the social media links for the document to share. There is also a link to share the document through email. - -.. figure:: img/document_sharing.png - :align: center - - *Document Sharing* - -You can **Rate** the document through the *Ratings system*. - -.. figure:: img/document_rating.png - :align: center - - *Rate the Document* - -In the **Comments Tab** section you can post your comment. Click on :guilabel:`Add Comment`, insert your comment and click :guilabel:`Submit Comment` to post it. - -.. figure:: img/document_comments.png - :align: center - - *Document Comments* - -Your comment will be added next to the last already existing comment. If you want to remove it click on the red :guilabel:`Delete` button. - -.. figure:: img/your_comment_on_document.png - :align: center - - *Your Comment* - -If you want this document in your *Favorites* (see :ref:`editing-profile`), open the **Favorite Tab** and click on :guilabel:`Add to Favorites`. - -.. figure:: img/favorite_document.png - :align: center - - *Your Favorite Comment* - -GeoNode also supports the *EXIF (EXchangeable Image Format)* for ``jpeg`` and ``tiff`` image documents. -The *EXIF* means that additional information (metadata) are stored within the image, so GeoNode allows you to see those information in the **Exif Tab**. - -.. figure:: img/exif_tab.png - :align: center - - *The EXIF tab* - -The Tools Section ------------------ - -On the right side of the *Document Page* you can see other useful information such as the links to the resources linked to the document, the document *Owner*, the *Point of Contact* and the *Metadata Author*. - -.. figure:: img/document_links_buttons.png - :align: center - - *Document useful tool* - -In the same section of the *Document Page* you can find the following useful tool: - -* :guilabel:`Metadata Detail` to explore in detail the document metadata (see the next paragraph) -* :guilabel:`Download Document` to download the document -* :guilabel:`Edit Document` to change the document metadata, replace the file etc (see :ref:`document-editing`) -* :guilabel:`Download Metadata` to download the whole set of metadata in various formats - - .. figure:: img/document_metadata_download.png - :align: center - - *Document Metadata download* - -* :guilabel:`Change Document Permissions` to assign permissions on the document to users and groups (see :ref:`edit-document-permissions`). - -Exploring Metadata Details --------------------------- - -When clicking on the :guilabel:`Metadata Detail` button the *Metadata Details Page* will open. - -.. figure:: img/document_metadata_details.png - :align: center - - *Document Metadata Details page* - -| It displays the whole set of available metadata about the document. -| Metadata are grouped in order to show the following types of information: - -* *Identification* to uniquely identify the document -* *Owner*, the user who own the document -* *Information*, the identification image, the Spatial Extent, Projection System and so on -* *Features*, Restrictions, Language and so on -* *Contact Points*, the user available to have a contact -* *References*, various links to the resource information -* *Metadata Author*, the metadata author information diff --git a/docs/usage/managing_documents/document_metadata.rst b/docs/usage/managing_documents/document_metadata.rst deleted file mode 100644 index e38c7dc1067..00000000000 --- a/docs/usage/managing_documents/document_metadata.rst +++ /dev/null @@ -1,73 +0,0 @@ -.. _document-metadata: - -Filling the Document Metadata -============================= - -Metadata contains all the information related to the document: they are its ID card. They provide essential information for its identification and its comprehension. Metadata also make the document more easily retrievable through search by other users. - -Editing a document's metadata is done in three steps (*Basic Metadata*, *Location and Licenses*, *Optional Metadata*). The first two steps are mandatory (no documents will be published if the required information are not provided) whereas the last one is optional. - -1. On the **Basic Metadata** page, the essential information that has to be filled is: - - * The *Title* of the document, which should be clear and understandable; - * The *Resources* the document should be linked to; - * An *Abstract* on the document; - * The *Creation/Publication/Revision* dates which define the time period that is covered by the document; - * The *Keywords*, which should be chosen within the available list. The contributor search for available keywords by clicking on the searching bar or by entering the first letters of the desired word. Key-words should be relevant to the imported document; - * The *Category* in which the document belongs; - * The *Group* to which the document is linked. - - .. figure:: img/document_basic_metadata.png - :align: center - - *Document Basic Metadata* - - Once all the fields are filled, click on the blue button :guilabel:`Next >>` in the bottom right corner of the page. - - .. note:: When a document is linked to some resources, you can see that link on the *Resource Page*. - - .. figure:: img/documents_linked_to_layer.png - :align: center - :width: 500px - - *Documents linked to a Layer* - - It will be also visible on the :ref:`document-info` page. - - .. figure:: img/resources_linked_to_document.png - :align: center - :width: 500px - - *Resources linked to a Document* - -2. On the **Location and Licenses** page, the following information should be filled: - - * The *Language* of the document; - * The *Regions*, which informs on the spatial extent covered by the document. Proposed extents cover the following scales: global, continental, regional, national; - * The *Data Quality statement* (general explanation of the data producer's knowledge about the lineage of a dataset); - * Potential *Restrictions* to sharing the document should be provided in the Restrictions box. - - .. figure:: img/document_location_licenses.png - :align: center - - *Document Location and Licenses* - - Click on the blue button :guilabel:`Next >>` to go ahead to the next step. - -3. On the **Optional Metadata** page, complementary information can be added: - - * The *Edition* to indicate the reference or the source of the document; - * The *Purpose* of the document and its objectives; - * Any *Supplemental information* that can provide a better understanding of the uploaded document; - * The *Maintenance frequency* of the document; - * The *Spatial representation type* used. - - *Responsible Parties*, *Owner* and *Permissions* are listed on the right side of the page, you can edit them. - - .. figure:: img/document_optional_metadata.png - :align: center - - *Document Optional Metadata* - - | If all the mandatory information is filled out the document can be published, if not the ``Completeness`` progress bar warns you that something is missing. - | Click on the blue button :guilabel:`Update` to save information on the system. diff --git a/docs/usage/managing_documents/document_permissions.rst b/docs/usage/managing_documents/document_permissions.rst deleted file mode 100644 index ee17fa15266..00000000000 --- a/docs/usage/managing_documents/document_permissions.rst +++ /dev/null @@ -1,31 +0,0 @@ -.. _edit-document-permissions: - -Changing the Document Permissions -================================= - -GeoNode encourages to publicly, share and make available for download information uploaded on the platform. By default, anyone can see and download a document. However, the document responsible can choose to limit access to the document to some contributors and/or groups. - -Through the button shown in the picture below it is possible to manage the document permissions. - -.. figure:: img/changing_document_permissions_button.png - :align: center - - *The button to change permissions* - -The :guilabel:`Change Document Permissions` button on the right side of the document page allows to set up who can: - -* View the document; -* Download it; -* Edit its metadata; -* Manage it (update, delete, change permissions, publish/unpublish). - -See an example in the picture below. - -.. figure:: img/changing_document_permissions.png - :align: center - - *Changing the Document permissions* - -Usually that editing of metadata and the management of a document are in charge of the responsible of the document, i.e. the contributor who uploaded it and who has those permissions by default. - -Once the permissions are set, click :guilabel:`Apply changes` to save them. diff --git a/docs/usage/managing_documents/img/changing_document_permissions.png b/docs/usage/managing_documents/img/changing_document_permissions.png deleted file mode 100644 index a7da614c84a..00000000000 Binary files a/docs/usage/managing_documents/img/changing_document_permissions.png and /dev/null differ diff --git a/docs/usage/managing_documents/img/changing_document_permissions_button.png b/docs/usage/managing_documents/img/changing_document_permissions_button.png deleted file mode 100644 index 4ae4dc05d21..00000000000 Binary files a/docs/usage/managing_documents/img/changing_document_permissions_button.png and /dev/null differ diff --git a/docs/usage/managing_documents/img/confirm_document_removal.png b/docs/usage/managing_documents/img/confirm_document_removal.png deleted file mode 100644 index 26a3b133069..00000000000 Binary files a/docs/usage/managing_documents/img/confirm_document_removal.png and /dev/null differ diff --git a/docs/usage/managing_documents/img/document_basic_metadata.png b/docs/usage/managing_documents/img/document_basic_metadata.png deleted file mode 100644 index 4fe2f1536e9..00000000000 Binary files a/docs/usage/managing_documents/img/document_basic_metadata.png and /dev/null differ diff --git a/docs/usage/managing_documents/img/document_comments.png b/docs/usage/managing_documents/img/document_comments.png deleted file mode 100644 index 448e83905d5..00000000000 Binary files a/docs/usage/managing_documents/img/document_comments.png and /dev/null differ diff --git a/docs/usage/managing_documents/img/document_editing_panel.png b/docs/usage/managing_documents/img/document_editing_panel.png deleted file mode 100644 index f2c0cae857b..00000000000 Binary files a/docs/usage/managing_documents/img/document_editing_panel.png and /dev/null differ diff --git a/docs/usage/managing_documents/img/document_info.png b/docs/usage/managing_documents/img/document_info.png deleted file mode 100644 index 3fa3d9328be..00000000000 Binary files a/docs/usage/managing_documents/img/document_info.png and /dev/null differ diff --git a/docs/usage/managing_documents/img/document_links_buttons.png b/docs/usage/managing_documents/img/document_links_buttons.png deleted file mode 100644 index 19fb35c7c53..00000000000 Binary files a/docs/usage/managing_documents/img/document_links_buttons.png and /dev/null differ diff --git a/docs/usage/managing_documents/img/document_location_licenses.png b/docs/usage/managing_documents/img/document_location_licenses.png deleted file mode 100644 index 95b1d5dea85..00000000000 Binary files a/docs/usage/managing_documents/img/document_location_licenses.png and /dev/null differ diff --git a/docs/usage/managing_documents/img/document_metadata_details.png b/docs/usage/managing_documents/img/document_metadata_details.png deleted file mode 100644 index ec411c56df3..00000000000 Binary files a/docs/usage/managing_documents/img/document_metadata_details.png and /dev/null differ diff --git a/docs/usage/managing_documents/img/document_metadata_download.png b/docs/usage/managing_documents/img/document_metadata_download.png deleted file mode 100644 index 6ed2c8a3e3b..00000000000 Binary files a/docs/usage/managing_documents/img/document_metadata_download.png and /dev/null differ diff --git a/docs/usage/managing_documents/img/document_metadata_editing.png b/docs/usage/managing_documents/img/document_metadata_editing.png deleted file mode 100644 index 213cfbb103d..00000000000 Binary files a/docs/usage/managing_documents/img/document_metadata_editing.png and /dev/null differ diff --git a/docs/usage/managing_documents/img/document_metadata_editing_buttons.png b/docs/usage/managing_documents/img/document_metadata_editing_buttons.png deleted file mode 100644 index 7d679d6e376..00000000000 Binary files a/docs/usage/managing_documents/img/document_metadata_editing_buttons.png and /dev/null differ diff --git a/docs/usage/managing_documents/img/document_optional_metadata.png b/docs/usage/managing_documents/img/document_optional_metadata.png deleted file mode 100644 index b44b9775f18..00000000000 Binary files a/docs/usage/managing_documents/img/document_optional_metadata.png and /dev/null differ diff --git a/docs/usage/managing_documents/img/document_rating.png b/docs/usage/managing_documents/img/document_rating.png deleted file mode 100644 index 72d65ac780f..00000000000 Binary files a/docs/usage/managing_documents/img/document_rating.png and /dev/null differ diff --git a/docs/usage/managing_documents/img/document_sharing.png b/docs/usage/managing_documents/img/document_sharing.png deleted file mode 100644 index f547364a84d..00000000000 Binary files a/docs/usage/managing_documents/img/document_sharing.png and /dev/null differ diff --git a/docs/usage/managing_documents/img/document_upload_page.png b/docs/usage/managing_documents/img/document_upload_page.png deleted file mode 100644 index 184bfe1241c..00000000000 Binary files a/docs/usage/managing_documents/img/document_upload_page.png and /dev/null differ diff --git a/docs/usage/managing_documents/img/document_uploading_thumbnail.png b/docs/usage/managing_documents/img/document_uploading_thumbnail.png deleted file mode 100644 index a8330530a8b..00000000000 Binary files a/docs/usage/managing_documents/img/document_uploading_thumbnail.png and /dev/null differ diff --git a/docs/usage/managing_documents/img/document_uploading_thumbnail_success.png b/docs/usage/managing_documents/img/document_uploading_thumbnail_success.png deleted file mode 100644 index d31f0606673..00000000000 Binary files a/docs/usage/managing_documents/img/document_uploading_thumbnail_success.png and /dev/null differ diff --git a/docs/usage/managing_documents/img/documents_linked_to_layer.png b/docs/usage/managing_documents/img/documents_linked_to_layer.png deleted file mode 100644 index a21b4d742ad..00000000000 Binary files a/docs/usage/managing_documents/img/documents_linked_to_layer.png and /dev/null differ diff --git a/docs/usage/managing_documents/img/exif_tab.png b/docs/usage/managing_documents/img/exif_tab.png deleted file mode 100644 index 6923ffbbcee..00000000000 Binary files a/docs/usage/managing_documents/img/exif_tab.png and /dev/null differ diff --git a/docs/usage/managing_documents/img/favorite_document.png b/docs/usage/managing_documents/img/favorite_document.png deleted file mode 100644 index 2d814165265..00000000000 Binary files a/docs/usage/managing_documents/img/favorite_document.png and /dev/null differ diff --git a/docs/usage/managing_documents/img/resources_linked_to_document.png b/docs/usage/managing_documents/img/resources_linked_to_document.png deleted file mode 100644 index d30f5b85923..00000000000 Binary files a/docs/usage/managing_documents/img/resources_linked_to_document.png and /dev/null differ diff --git a/docs/usage/managing_documents/img/upload_document_link.png b/docs/usage/managing_documents/img/upload_document_link.png deleted file mode 100644 index d07c6d64e8e..00000000000 Binary files a/docs/usage/managing_documents/img/upload_document_link.png and /dev/null differ diff --git a/docs/usage/managing_documents/img/upload_documents_button.png b/docs/usage/managing_documents/img/upload_documents_button.png deleted file mode 100644 index 03ddea90c65..00000000000 Binary files a/docs/usage/managing_documents/img/upload_documents_button.png and /dev/null differ diff --git a/docs/usage/managing_documents/img/your_comment_on_document.png b/docs/usage/managing_documents/img/your_comment_on_document.png deleted file mode 100644 index 0df641966ad..00000000000 Binary files a/docs/usage/managing_documents/img/your_comment_on_document.png and /dev/null differ diff --git a/docs/usage/managing_documents/index.rst b/docs/usage/managing_documents/index.rst deleted file mode 100644 index b8d24c62957..00000000000 --- a/docs/usage/managing_documents/index.rst +++ /dev/null @@ -1,14 +0,0 @@ -Managing Documents -================== - -| In this section all the aspects concerning :ref:`document-data-type` will be discussed. -| You will learn how to upload a document and how to inspect its metadata and details. All the editing tools will be also explained. - -.. toctree:: - :maxdepth: 1 - - uploading_documents - document_metadata - document_info - document_editing - document_permissions diff --git a/docs/usage/managing_documents/uploading_documents.rst b/docs/usage/managing_documents/uploading_documents.rst deleted file mode 100644 index ee6907dc7b6..00000000000 --- a/docs/usage/managing_documents/uploading_documents.rst +++ /dev/null @@ -1,40 +0,0 @@ -.. _uploading-documents: - -Uploading Documents -=================== - -GeoNode allows to share reports, conceptual notes, posters, spreadsheets, etc. A wide range of documents files can be hosted on the platform, including text files (.doc, .docx, .txt, .odt), spreadsheets (.xls, .xlsx, .ods), presentations (.ppt, .pptx, .odp), images (.gif, .jpg, .png, .tif, .tiff), PDF, zip files (.rar, .zip, .gz), SLD, XML or QML files. - -.. warning:: Only authenticated users can upload data into GeoNode. - -*Documents* uploading is accessible from two positions: - -* the :guilabel:`Upload Documents` button of the *Documents Search* page (see :ref:`finding-documents`) - - .. figure:: img/upload_documents_button.png - :align: center - - *Documents Upload button* - -* the :guilabel:`Upload Document` link of the :guilabel:`Data` menu in the navigation bar - - .. figure:: img/upload_document_link.png - :align: center - - *Document Upload link* - -The *Document Upload* page looks like the one shown in the picture below. - - .. figure:: img/document_upload_page.png - :align: center - - *Document Upload page* - -In order to upload a document: - -#. select a file from your disk or enter a URL address if the document is stored on the internet -#. insert the title of the document -#. select one or more published resources the document can be linked to (optional) -#. click the red :guilabel:`Upload` button - -At the end of the uploading process you will be driven to the *Metadata* page to fill out other information about the document. See the next section to know more about that. diff --git a/docs/usage/managing_layers/img/add_new_feature.gif b/docs/usage/managing_layers/img/add_new_feature.gif deleted file mode 100644 index 06b09304bc4..00000000000 Binary files a/docs/usage/managing_layers/img/add_new_feature.gif and /dev/null differ diff --git a/docs/usage/managing_layers/img/add_new_feature_button.png b/docs/usage/managing_layers/img/add_new_feature_button.png deleted file mode 100644 index 36fab1fab23..00000000000 Binary files a/docs/usage/managing_layers/img/add_new_feature_button.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/add_shape_to_existing_geometry.gif b/docs/usage/managing_layers/img/add_shape_to_existing_geometry.gif deleted file mode 100644 index 92c33fd2c70..00000000000 Binary files a/docs/usage/managing_layers/img/add_shape_to_existing_geometry.gif and /dev/null differ diff --git a/docs/usage/managing_layers/img/add_shape_to_geometry_button.png b/docs/usage/managing_layers/img/add_shape_to_geometry_button.png deleted file mode 100644 index 4dcd7d55aff..00000000000 Binary files a/docs/usage/managing_layers/img/add_shape_to_geometry_button.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/add_style_button.png b/docs/usage/managing_layers/img/add_style_button.png deleted file mode 100644 index 43cbb1f211b..00000000000 Binary files a/docs/usage/managing_layers/img/add_style_button.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/advanced_edit_button.png b/docs/usage/managing_layers/img/advanced_edit_button.png deleted file mode 100644 index 267dded0690..00000000000 Binary files a/docs/usage/managing_layers/img/advanced_edit_button.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/basic_layer_metadata.png b/docs/usage/managing_layers/img/basic_layer_metadata.png deleted file mode 100644 index fb211d6034a..00000000000 Binary files a/docs/usage/managing_layers/img/basic_layer_metadata.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/change_layer_permissions.png b/docs/usage/managing_layers/img/change_layer_permissions.png deleted file mode 100644 index 8bb0f0b7bb0..00000000000 Binary files a/docs/usage/managing_layers/img/change_layer_permissions.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/completeness_progress_bar.png b/docs/usage/managing_layers/img/completeness_progress_bar.png deleted file mode 100644 index 47ac3712e24..00000000000 Binary files a/docs/usage/managing_layers/img/completeness_progress_bar.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/create_layer_link.png b/docs/usage/managing_layers/img/create_layer_link.png deleted file mode 100644 index b4380add573..00000000000 Binary files a/docs/usage/managing_layers/img/create_layer_link.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/create_new_style_button.png b/docs/usage/managing_layers/img/create_new_style_button.png deleted file mode 100644 index 13df619e585..00000000000 Binary files a/docs/usage/managing_layers/img/create_new_style_button.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/create_new_style_from_templates.png b/docs/usage/managing_layers/img/create_new_style_from_templates.png deleted file mode 100644 index 5dd93b83878..00000000000 Binary files a/docs/usage/managing_layers/img/create_new_style_from_templates.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/dataset_attributes_layer_metadata.png b/docs/usage/managing_layers/img/dataset_attributes_layer_metadata.png deleted file mode 100644 index 27746cb365a..00000000000 Binary files a/docs/usage/managing_layers/img/dataset_attributes_layer_metadata.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/delete_feature.gif b/docs/usage/managing_layers/img/delete_feature.gif deleted file mode 100644 index e7a018c15b4..00000000000 Binary files a/docs/usage/managing_layers/img/delete_feature.gif and /dev/null differ diff --git a/docs/usage/managing_layers/img/delete_feature_button.png b/docs/usage/managing_layers/img/delete_feature_button.png deleted file mode 100644 index 7d30728efe1..00000000000 Binary files a/docs/usage/managing_layers/img/delete_feature_button.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/delete_style_button.png b/docs/usage/managing_layers/img/delete_style_button.png deleted file mode 100644 index f3ea07896b5..00000000000 Binary files a/docs/usage/managing_layers/img/delete_style_button.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/download_filtered_data.gif b/docs/usage/managing_layers/img/download_filtered_data.gif deleted file mode 100644 index de644337d56..00000000000 Binary files a/docs/usage/managing_layers/img/download_filtered_data.gif and /dev/null differ diff --git a/docs/usage/managing_layers/img/download_layer_data.png b/docs/usage/managing_layers/img/download_layer_data.png deleted file mode 100644 index 2aeec876f3c..00000000000 Binary files a/docs/usage/managing_layers/img/download_layer_data.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/download_layer_image.png b/docs/usage/managing_layers/img/download_layer_image.png deleted file mode 100644 index 845b58aedc5..00000000000 Binary files a/docs/usage/managing_layers/img/download_layer_image.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/download_metadata.png b/docs/usage/managing_layers/img/download_metadata.png deleted file mode 100644 index ca1582b4cc8..00000000000 Binary files a/docs/usage/managing_layers/img/download_metadata.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/edit_feature_attributes.gif b/docs/usage/managing_layers/img/edit_feature_attributes.gif deleted file mode 100644 index 93de4ba9e1b..00000000000 Binary files a/docs/usage/managing_layers/img/edit_feature_attributes.gif and /dev/null differ diff --git a/docs/usage/managing_layers/img/edit_feature_shape.gif b/docs/usage/managing_layers/img/edit_feature_shape.gif deleted file mode 100644 index 01f57a37013..00000000000 Binary files a/docs/usage/managing_layers/img/edit_feature_shape.gif and /dev/null differ diff --git a/docs/usage/managing_layers/img/edit_mode_button.png b/docs/usage/managing_layers/img/edit_mode_button.png deleted file mode 100644 index ff26b250586..00000000000 Binary files a/docs/usage/managing_layers/img/edit_mode_button.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/edit_style_button.png b/docs/usage/managing_layers/img/edit_style_button.png deleted file mode 100644 index 831cc16a6a4..00000000000 Binary files a/docs/usage/managing_layers/img/edit_style_button.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/editing_layer_data.png b/docs/usage/managing_layers/img/editing_layer_data.png deleted file mode 100644 index 42e0084a3bf..00000000000 Binary files a/docs/usage/managing_layers/img/editing_layer_data.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/end_editing_session_button.png b/docs/usage/managing_layers/img/end_editing_session_button.png deleted file mode 100644 index 9caceb6b69a..00000000000 Binary files a/docs/usage/managing_layers/img/end_editing_session_button.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/favorite_layer.png b/docs/usage/managing_layers/img/favorite_layer.png deleted file mode 100644 index e2d2f498d48..00000000000 Binary files a/docs/usage/managing_layers/img/favorite_layer.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/geometry_types.png b/docs/usage/managing_layers/img/geometry_types.png deleted file mode 100644 index a42a46825f1..00000000000 Binary files a/docs/usage/managing_layers/img/geometry_types.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/layer_attributes_tab.png b/docs/usage/managing_layers/img/layer_attributes_tab.png deleted file mode 100644 index 27bfff4f16b..00000000000 Binary files a/docs/usage/managing_layers/img/layer_attributes_tab.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/layer_comments.png b/docs/usage/managing_layers/img/layer_comments.png deleted file mode 100644 index f0a532bff0d..00000000000 Binary files a/docs/usage/managing_layers/img/layer_comments.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/layer_default_style.png b/docs/usage/managing_layers/img/layer_default_style.png deleted file mode 100644 index 5bcb1df9971..00000000000 Binary files a/docs/usage/managing_layers/img/layer_default_style.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/layer_editing_panel.png b/docs/usage/managing_layers/img/layer_editing_panel.png deleted file mode 100644 index 44e2afe9628..00000000000 Binary files a/docs/usage/managing_layers/img/layer_editing_panel.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/layer_images_download.png b/docs/usage/managing_layers/img/layer_images_download.png deleted file mode 100644 index 9bbd96d9156..00000000000 Binary files a/docs/usage/managing_layers/img/layer_images_download.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/layer_info.png b/docs/usage/managing_layers/img/layer_info.png deleted file mode 100644 index 7a76798d278..00000000000 Binary files a/docs/usage/managing_layers/img/layer_info.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/layer_info_tab.png b/docs/usage/managing_layers/img/layer_info_tab.png deleted file mode 100644 index ffd910c0c80..00000000000 Binary files a/docs/usage/managing_layers/img/layer_info_tab.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/layer_metadata_detail_button.png b/docs/usage/managing_layers/img/layer_metadata_detail_button.png deleted file mode 100644 index c660b53578d..00000000000 Binary files a/docs/usage/managing_layers/img/layer_metadata_detail_button.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/layer_metadata_details_page.png b/docs/usage/managing_layers/img/layer_metadata_details_page.png deleted file mode 100644 index b548d8bbb88..00000000000 Binary files a/docs/usage/managing_layers/img/layer_metadata_details_page.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/layer_permissions_settings.png b/docs/usage/managing_layers/img/layer_permissions_settings.png deleted file mode 100644 index 9a33af3d28c..00000000000 Binary files a/docs/usage/managing_layers/img/layer_permissions_settings.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/layer_preview.gif b/docs/usage/managing_layers/img/layer_preview.gif deleted file mode 100644 index 463fec2df60..00000000000 Binary files a/docs/usage/managing_layers/img/layer_preview.gif and /dev/null differ diff --git a/docs/usage/managing_layers/img/layer_preview_change_style.png b/docs/usage/managing_layers/img/layer_preview_change_style.png deleted file mode 100644 index 2d25bbc58b1..00000000000 Binary files a/docs/usage/managing_layers/img/layer_preview_change_style.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/layer_rating.png b/docs/usage/managing_layers/img/layer_rating.png deleted file mode 100644 index 73c0be1ef06..00000000000 Binary files a/docs/usage/managing_layers/img/layer_rating.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/layer_settings_button.png b/docs/usage/managing_layers/img/layer_settings_button.png deleted file mode 100644 index eda613606ef..00000000000 Binary files a/docs/usage/managing_layers/img/layer_settings_button.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/layer_sharing.png b/docs/usage/managing_layers/img/layer_sharing.png deleted file mode 100644 index d9a25563649..00000000000 Binary files a/docs/usage/managing_layers/img/layer_sharing.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/layers_uploading_page.png b/docs/usage/managing_layers/img/layers_uploading_page.png deleted file mode 100644 index 786919f434a..00000000000 Binary files a/docs/usage/managing_layers/img/layers_uploading_page.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/location_licenses_layer_metadata.png b/docs/usage/managing_layers/img/location_licenses_layer_metadata.png deleted file mode 100644 index dea0fe9b5dd..00000000000 Binary files a/docs/usage/managing_layers/img/location_licenses_layer_metadata.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/magnifying_glass_icon.png b/docs/usage/managing_layers/img/magnifying_glass_icon.png deleted file mode 100644 index fa53082a1a0..00000000000 Binary files a/docs/usage/managing_layers/img/magnifying_glass_icon.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/manage_styles.png b/docs/usage/managing_layers/img/manage_styles.png deleted file mode 100644 index a97d03d76e3..00000000000 Binary files a/docs/usage/managing_layers/img/manage_styles.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/manage_styles_button.png b/docs/usage/managing_layers/img/manage_styles_button.png deleted file mode 100644 index 21c3328d40d..00000000000 Binary files a/docs/usage/managing_layers/img/manage_styles_button.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/metadata_upload.png b/docs/usage/managing_layers/img/metadata_upload.png deleted file mode 100644 index af0ef897762..00000000000 Binary files a/docs/usage/managing_layers/img/metadata_upload.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/new_layer_from_scratch.gif b/docs/usage/managing_layers/img/new_layer_from_scratch.gif deleted file mode 100644 index 9368e7c6e9c..00000000000 Binary files a/docs/usage/managing_layers/img/new_layer_from_scratch.gif and /dev/null differ diff --git a/docs/usage/managing_layers/img/new_remote_service.gif b/docs/usage/managing_layers/img/new_remote_service.gif deleted file mode 100644 index 26dd81fc311..00000000000 Binary files a/docs/usage/managing_layers/img/new_remote_service.gif and /dev/null differ diff --git a/docs/usage/managing_layers/img/new_style_in_layer_page.png b/docs/usage/managing_layers/img/new_style_in_layer_page.png deleted file mode 100644 index 3bdc8633399..00000000000 Binary files a/docs/usage/managing_layers/img/new_style_in_layer_page.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/new_style_in_list.png b/docs/usage/managing_layers/img/new_style_in_list.png deleted file mode 100644 index c3ef12a1236..00000000000 Binary files a/docs/usage/managing_layers/img/new_style_in_list.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/new_style_title.png b/docs/usage/managing_layers/img/new_style_title.png deleted file mode 100644 index 5e171774e14..00000000000 Binary files a/docs/usage/managing_layers/img/new_style_title.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/optional_layer_metadata.png b/docs/usage/managing_layers/img/optional_layer_metadata.png deleted file mode 100644 index f7a69c751cc..00000000000 Binary files a/docs/usage/managing_layers/img/optional_layer_metadata.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/remote_service_metadata.png b/docs/usage/managing_layers/img/remote_service_metadata.png deleted file mode 100644 index ec450595827..00000000000 Binary files a/docs/usage/managing_layers/img/remote_service_metadata.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/remote_services.png b/docs/usage/managing_layers/img/remote_services.png deleted file mode 100644 index a714bdb0091..00000000000 Binary files a/docs/usage/managing_layers/img/remote_services.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/remote_services_link.png b/docs/usage/managing_layers/img/remote_services_link.png deleted file mode 100644 index 857c49c18bd..00000000000 Binary files a/docs/usage/managing_layers/img/remote_services_link.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/replace_layer_page.png b/docs/usage/managing_layers/img/replace_layer_page.png deleted file mode 100644 index bae90e02b1c..00000000000 Binary files a/docs/usage/managing_layers/img/replace_layer_page.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/replace_layer_result.png b/docs/usage/managing_layers/img/replace_layer_result.png deleted file mode 100644 index 5c6c7a8cf2a..00000000000 Binary files a/docs/usage/managing_layers/img/replace_layer_result.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/replace_layer_success.png b/docs/usage/managing_layers/img/replace_layer_success.png deleted file mode 100644 index 415b94c6cd8..00000000000 Binary files a/docs/usage/managing_layers/img/replace_layer_success.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/save_changes_button.png b/docs/usage/managing_layers/img/save_changes_button.png deleted file mode 100644 index 99dfe868b54..00000000000 Binary files a/docs/usage/managing_layers/img/save_changes_button.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/save_style_button.png b/docs/usage/managing_layers/img/save_style_button.png deleted file mode 100644 index 7b4845c60f0..00000000000 Binary files a/docs/usage/managing_layers/img/save_style_button.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/service_type.png b/docs/usage/managing_layers/img/service_type.png deleted file mode 100644 index ae85266b68a..00000000000 Binary files a/docs/usage/managing_layers/img/service_type.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/set_style_as_default_button.png b/docs/usage/managing_layers/img/set_style_as_default_button.png deleted file mode 100644 index 19e00782266..00000000000 Binary files a/docs/usage/managing_layers/img/set_style_as_default_button.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/set_thumbnail_confirmation_message.png b/docs/usage/managing_layers/img/set_thumbnail_confirmation_message.png deleted file mode 100644 index 108aaaaf982..00000000000 Binary files a/docs/usage/managing_layers/img/set_thumbnail_confirmation_message.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/style_editor.gif b/docs/usage/managing_layers/img/style_editor.gif deleted file mode 100644 index eea0f32ac57..00000000000 Binary files a/docs/usage/managing_layers/img/style_editor.gif and /dev/null differ diff --git a/docs/usage/managing_layers/img/style_editor_button.png b/docs/usage/managing_layers/img/style_editor_button.png deleted file mode 100644 index a7088d9cf80..00000000000 Binary files a/docs/usage/managing_layers/img/style_editor_button.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/style_editor_syntax_validator.png b/docs/usage/managing_layers/img/style_editor_syntax_validator.png deleted file mode 100644 index fe7a779eb4e..00000000000 Binary files a/docs/usage/managing_layers/img/style_editor_syntax_validator.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/style_tab.png b/docs/usage/managing_layers/img/style_tab.png deleted file mode 100644 index 20333ee504d..00000000000 Binary files a/docs/usage/managing_layers/img/style_tab.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/style_templates.png b/docs/usage/managing_layers/img/style_templates.png deleted file mode 100644 index 3fa62ba162b..00000000000 Binary files a/docs/usage/managing_layers/img/style_templates.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/styles_map_panel.png b/docs/usage/managing_layers/img/styles_map_panel.png deleted file mode 100644 index b27907b88ae..00000000000 Binary files a/docs/usage/managing_layers/img/styles_map_panel.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/toc_button.png b/docs/usage/managing_layers/img/toc_button.png deleted file mode 100644 index 6b15aac4626..00000000000 Binary files a/docs/usage/managing_layers/img/toc_button.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/upload_SLD_button.png b/docs/usage/managing_layers/img/upload_SLD_button.png deleted file mode 100644 index 5ef715e6065..00000000000 Binary files a/docs/usage/managing_layers/img/upload_SLD_button.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/upload_layer_link.png b/docs/usage/managing_layers/img/upload_layer_link.png deleted file mode 100644 index 8c4f917c9cf..00000000000 Binary files a/docs/usage/managing_layers/img/upload_layer_link.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/upload_layer_link_from_list.png b/docs/usage/managing_layers/img/upload_layer_link_from_list.png deleted file mode 100644 index 6ec10273e07..00000000000 Binary files a/docs/usage/managing_layers/img/upload_layer_link_from_list.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/upload_shapefile.gif b/docs/usage/managing_layers/img/upload_shapefile.gif deleted file mode 100644 index 25fd2fab650..00000000000 Binary files a/docs/usage/managing_layers/img/upload_shapefile.gif and /dev/null differ diff --git a/docs/usage/managing_layers/img/upload_style_button.png b/docs/usage/managing_layers/img/upload_style_button.png deleted file mode 100644 index 57bce76404f..00000000000 Binary files a/docs/usage/managing_layers/img/upload_style_button.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/upload_styles.png b/docs/usage/managing_layers/img/upload_styles.png deleted file mode 100644 index d2ffbe69b55..00000000000 Binary files a/docs/usage/managing_layers/img/upload_styles.png and /dev/null differ diff --git a/docs/usage/managing_layers/img/upload_thumbnail.png b/docs/usage/managing_layers/img/upload_thumbnail.png deleted file mode 100644 index 64108e03421..00000000000 Binary files a/docs/usage/managing_layers/img/upload_thumbnail.png and /dev/null differ diff --git a/docs/usage/managing_layers/index.rst b/docs/usage/managing_layers/index.rst deleted file mode 100644 index d64a064d1f6..00000000000 --- a/docs/usage/managing_layers/index.rst +++ /dev/null @@ -1,18 +0,0 @@ -Managing Layers -=============== - -| Layers are published resources representing raster o vector spatial data sources. Layers can also be associated with metadata, ratings, and comments. -| In this section, you will learn how to create a new layer by uploading a local data set, add layer info, change the style of the layer, and share the results. - -.. toctree:: - :maxdepth: 1 - - uploading_layers - new_layer_from_scratch - using_remote_services - layer_permissions - layer_info - layer_download - layer_editing - layer_metadata - layer_styling diff --git a/docs/usage/managing_layers/layer_download.rst b/docs/usage/managing_layers/layer_download.rst deleted file mode 100644 index 88d73856302..00000000000 --- a/docs/usage/managing_layers/layer_download.rst +++ /dev/null @@ -1,26 +0,0 @@ -.. _layer-download: - -Downloading Layers -================== - -| At the top of the *Layer Page* there is the :guilabel:`Download Layer` button (see :ref:`layer-info`). It provides access to the ability to extract geospatial data from within GeoNode. -| You will see a list of options of the supported export formats. You can choose the *Images* formats ``PNG``, ``PDF``, ``JPEG`` if you want to save a "screenshot-like" image of the layer. - -.. figure:: img/download_layer_image.png - :align: center - - *Downloading Layers as Images* - -You can also download the layer data, the supported export formats will be listed in the *Data* tab. Click on your desired format to trigger the download. - -.. figure:: img/download_layer_data.png - :align: center - - *Downloading the Layer Data* - -As shown in the image above, GeoNode allows you to download a subset of data. Click on :guilabel:`Do you want to filter it?` to filter the layer data before the download. - -.. figure:: img/download_filtered_data.gif - :align: center - - *Downloading the Layer Data* diff --git a/docs/usage/managing_layers/layer_editing.rst b/docs/usage/managing_layers/layer_editing.rst deleted file mode 100644 index 26f95d5a245..00000000000 --- a/docs/usage/managing_layers/layer_editing.rst +++ /dev/null @@ -1,168 +0,0 @@ -.. _layer-editing: - -Layer Editing -============= - -The :guilabel:`Editing Tools` button of the *Layer Page* (see :ref:`layer-info`) opens a panel like the one shown in the picture below. - -.. figure:: img/layer_editing_panel.png - :align: center - - *The Layer Editing panel* - -In that panel you can see many options grouped by four categories: - -1. *Metadata* -2. *Styles* -3. *Thumbnail* -4. *Layer* - -In this section you will learn how to edit a *Layer*, how to replace and edit its data. See :ref:`layer-metadata` to learn how to explore the layer *Metadata*, how to upload and edit them. The *Styles* will be covered in a dedicated section, see :ref:`layer-style`. - -Setting the Layer Thumbnail ---------------------------- - -| The Thumbnail of the layer that will be displayed on the *Layers* list page can be changed by dragging and zooming on the layer preview to select which portion will be displayed, then by clicking on the :guilabel:`Set` button of the *Layer Editing* panel. -| A message will confirm the thumbnail has been correctly changed. - -.. figure:: img/set_thumbnail_confirmation_message.png - :align: center - - *The Layer Editing panel* - -It is also possible to manually upload a thumbnail by using the :guilabel:`Upload` button of the *Layer Editing* panel. -Using the "Upload Thumbnail" page it is possible to enable the automatically generated thumbnail or upload an image to be used in place of it. - -.. figure:: img/upload_thumbnail.png - :align: center - - *The Upload Thumbnail panel* - - -Replacing the Layer -------------------- - -From the *Layer Editing* panel click on :guilabel:`Replace` to change the layer source dataset. You will be driven to the *Replace Layer* page in which :guilabel:`Choose Files` button allows you to select files from your disk. - -.. figure:: img/replace_layer_page.png - :align: center - - *Replace a Layer* - -Once the *Charset* selected the upload process can be triggered by clicking on :guilabel:`Replace Layer`. If no errors occur you will see a message like the one in the picture below. - -.. figure:: img/replace_layer_success.png - :align: center - - *Replace Layer success* - -We have replaced the *roads* dataset with the *railways* one. You can see the differences in the *Layer Preview*. - -.. figure:: img/replace_layer_result.png - :align: center - - *Result of the Layer Replacement* - -.. _layer-data-editing: - -Editing the Layer Data ----------------------- - -The :guilabel:`Edit data` button of the *Layer Editing* panel opens the *Layer* within a *Map*. - -.. figure:: img/editing_layer_data.png - :align: center - - *Editing the Layer Data* - -The *Attribute Table* panel of the *Layer* will automatically appear at the bottom of the *Map*. In that panel all the features are listed. For each feature you can zoom to its extent by clicking on the corresponding *magnifying glass* icon |magnifying_glass_icon| at the beginning of the row, you can also observe which values the feature assumes for each attribute. - -.. |magnifying_glass_icon| image:: img/magnifying_glass_icon.png - :width: 30px - :height: 30px - :align: middle - -Click the *Edit Mode* |edit_mode_button| button to start an editing session. - -.. |edit_mode_button| image:: img/edit_mode_button.png - :width: 30px - :height: 30px - :align: middle - -Now you can: - -* *Add new Features* - - Through the *Add New Feature* button |add_new_feature_button| it is possible to set up a new feature for your layer. - Fill the attributes fields and click |save_changes_button| to save your change. - Your new feature doesn't have a shape yet, click on |add_shape_to_geometry_button| to draw its shape directly on the *Map* then click on |save_changes_button| to save it. - - .. |add_new_feature_button| image:: img/add_new_feature_button.png - :width: 30px - :height: 30px - :align: middle - - .. |save_changes_button| image:: img/save_changes_button.png - :width: 30px - :height: 30px - :align: middle - - .. |add_shape_to_geometry_button| image:: img/add_shape_to_geometry_button.png - :width: 30px - :height: 30px - :align: middle - - .. figure:: img/add_new_feature.gif - :align: center - - *Add a New Feature to the Layer* - - .. note:: When your new feature has a multi-vertex shape you have to double-click the last vertex to finish the drawing. - -* *Delete Features* - - If you want to delete a feature you have to select it on the *Attribute Table* and click on |delete_feature_button|. - - .. |delete_feature_button| image:: img/delete_feature_button.png - :width: 30px - :height: 30px - :align: middle - - .. figure:: img/delete_feature.gif - :align: center - - *Delete a Feature* - -* *Change the Feature Shape* - - You can edit the shape of an existing geometry dragging its vertices with the mouse. A blue circle lets you know what vertex you are moving. - - .. figure:: img/edit_feature_shape.gif - :align: center - - *Feature Shape Editing - Change the existing shape* - - Features can have *multipart shapes*. You can add parts to the shape when editing it. - - .. figure:: img/add_shape_to_existing_geometry.gif - :align: center - - *Feature Shape Editing - Add parts to the existing shape* - -* *Change the Feature Attributes* - - When you are in *Edit Mode* you can also edit the attributes values changing them directly in the corresponding text fields. - - .. figure:: img/edit_feature_attributes.gif - :align: center - - *Feature Attributes Editing* - -Once you have finished you can end the *Editing Session* by clicking on the |end_editing_session_button| button. - -.. |end_editing_session_button| image:: img/end_editing_session_button.png - :width: 30px - :height: 30px - :align: middle - -By default the GeoNode map viewer is `MapStore `_ based, see the `MapStore Documentation `_ for further information. diff --git a/docs/usage/managing_layers/layer_info.rst b/docs/usage/managing_layers/layer_info.rst deleted file mode 100644 index 6f61639a943..00000000000 --- a/docs/usage/managing_layers/layer_info.rst +++ /dev/null @@ -1,110 +0,0 @@ -.. _layer-info: - -Layer Information -================= - -| In this section you will learn more about layers. In the :ref:`finding-layers` section we explain how to find layers, now we want to go more in depth showing you how to explore detailed information about that. -| From the layers list page, click on the layer you are interested in. The *Layer Page* will open. - -.. figure:: img/layer_info.png - :align: center - - *Layer Information* - -As shown in the picture above, the *Layer Page* is divided into three main sections: - -1. the *Layer Preview* section, under the title -2. the *Tabs* section, under the layer preview -3. the *Tools* section, on the right side of the page - -Layer Preview -------------- - -The *Layer Preview* shows the layer in a map with very basic functionalities: - -* the *Base Map Switcher* that allows you to change the base map; -* the *Zoom in/out* tool to enlarge and decrease the view; -* the *Zoom to max extent* tool for the zoom to fit the layer size; -* the *Query Objects* tool to retrieve information about the map objects by clicking on the map; -* the *Print* tool to print the preview. - -.. figure:: img/layer_preview.gif - :align: center - - *Layer Preview* - -The GeoNode map viewer is `MapStore `_ based, see the `MapStore Documentation `_ to learn more. - -Tabs Sections -------------- - -The *Layer Page* shows you some tabs sections containing different information about the layer: - -* The tab *Info* is active by default. This tab section shows some layer metadata such as its title, the abstract, date of publication etc. The metadata also indicates the layer owner, what are the topic categories the layer belongs to and which regions are affected. - - .. figure:: img/layer_info_tab.png - :align: center - - *Layer Info tab* - -* The *Attributes* tab shows the data structure behind the layer. All the attributes are listed and for each of them some statistics (e.g. the range of values) are estimated (if possible). - - .. figure:: img/layer_attributes_tab.png - :align: center - - *Layer Attributes tab* - -* The *Share* tab provides the links for the layer to share through social media or email. - - .. figure:: img/layer_sharing.png - :align: center - - *Layer Sharing* - -* You can *Rate* the layer through the *Rating system*. - - .. figure:: img/layer_rating.png - :align: center - - *Rate the Layer* - -* In the *Comments* tab section you can post your comment. Click on :guilabel:`Add Comment`, insert your comment and click :guilabel:`Submit Comment` to post it. - - .. figure:: img/layer_comments.png - :align: center - - *Layer Comments* - - Your comment will be added next to the last already existing comment. If you want to remove it click on the red :guilabel:`Delete` button. - -* If you want this layer in your *Favorites* (see :ref:`editing-profile`), open the *Favorite* tab and click on :guilabel:`Add to Favorites`. - - .. figure:: img/favorite_layer.png - :align: center - - *Your Favorite Layer* - -Layer Tools ------------ - -In the right side of the *Layer Page* there are some buttons and information that can help you to manage your layer. This paragraph will cover only those tools which show layers information. The *Editing Tools* will be explored in the :ref:`layer-editing` section. - -* through the :guilabel:`Download Layer` button you can download your layer with some options, see :ref:`layer-download`; -* the :guilabel:`Metadata Detail` button to see the layer metadata, see :ref:`layer-metadata` to read more; -* the :guilabel:`Editing Tools` button allows you to access to many editing tools. Those functionalities will be explained in the :ref:`layer-editing` section; -* the :guilabel:`View Layer` button opens the layer loaded in a map, see the :ref:`map-info` for more details; -* the :guilabel:`Download Metadata` button allows you to download the layer metadata in various formats; -* the *Legend* shows what the symbols and styles on the map are referring to; -* in the *Map using this layer* section all the map which uses the layer are listed; -* in the *Create a map using this layer*, the :guilabel:`Create a Map` button allows you to create a map from scratch using the layer; -* the section *Add the layer to an existing map* shows you a dropdown menu in which all the maps the user can view are listed. The button :guilabel:`Add to Map` allows you to add the layer to the map you have selected in the previous menu; -* the *Styles* section shows all the styles associated with the layer. Click on the checkbox corresponding to one of the styles listed to apply it the preview; - - .. figure:: img/layer_preview_change_style.png - :align: center - - *Change the Layer Style in preview* - -* in the *Refresh Attributes and Statistics of this layer* section the :guilabel:`Refresh Attributes and Statistics` allows GeoNode to refresh the list of available Layer Attributes. If the option 'WPS_ENABLED' has been also set on the backend, it will recalculate their statistics too; -* in the *Clear the Server Cache of this layer* section the :guilabel:`Empty Tiled-Layer Cache` allows to wipe the tile-cache of this layer; -* the *About* section shows you the layer *Owner*, the *Contact* user and the *Metadata Author*. diff --git a/docs/usage/managing_layers/layer_metadata.rst b/docs/usage/managing_layers/layer_metadata.rst deleted file mode 100644 index 989d187c737..00000000000 --- a/docs/usage/managing_layers/layer_metadata.rst +++ /dev/null @@ -1,152 +0,0 @@ -.. _layer-metadata: - -Layers Metadata -=============== - -In GeoNode special importance is given to *Metadata* and their standard formats. -You can explore the *Metadata* of a *Layer* by clicking the :guilabel:`Metadata Detail` button from the *Layer Page*. - -.. figure:: img/layer_metadata_detail_button.png - :align: center - - *The Layer Metadata Detail button* - -The *Layer Metadata* page will be displayed. - -.. figure:: img/layer_metadata_details_page.png - :align: center - - *The Layer Metadata Details* - -In that page you can see the whole set of available metadata about the layer. -Metadata are grouped in order to show the following types of information: - - * *Identification* to uniquely identify the layer (Title, Abstract, Publication Date etc.); - * *Owner*, the user who owns the layer; - * *Information*, the Identification Image, the Spatial Extent, Projection System and so on; - * *Features*, Language, Supplemental and other Information; - * *Contact Points*, the available user to get in contact; - * *References*, various links to the resource information and data; - * *Metadata Author*, information about the author of the metadata. - -Downloading Metadata --------------------- - -The :guilabel:`Download Metadata` button of the *Layer Page* allows you to download the layer metadata in various formats. - -.. figure:: img/download_metadata.png - :align: center - - *How to Download Metadata* - -The available download formats are grouped in three categories: - -* *Full metadata* -* *Standard Metadata - XML format* -* *Attribute Information* - -Click on the format name that you prefer to start the download. - -Metadata Wizard ---------------- - -| Metadata contains all the information related to the layer. They provide essential information for its identification and its comprehension. Metadata also make the layer more easily retrievable through search by other users. -| The *Metadata* of a layer can be changed through a *Wizard* which involves four steps, one for each type of metadata considered: - -* *Basic Metadata* - - The first two steps are mandatory (no layers will be published if the required information are not provided) whereas the last two are optional. - - .. figure:: img/basic_layer_metadata.png - :align: center - - *Basic Layer Metadata* - - In the first step the system asks you to insert the following metadata: - - * The *Thumbnail* of the layer (click :guilabel:`Edit` to change it); - * The *Title* of the layer, which should be clear and understandable; - * An *Abstract* on the layer; - * The *Creation/Publication/Revision Dates* which define the time period that is covered by the layer; - * The *Keywords*, which should be chosen within the available list. The contributor search for available keywords by clicking on the searching bar or by entering the first letters of the desired word; - * The *Category* which the layer belongs to; - * The *Group* which the layer is linked to. - -* *Location and Licenses* - - .. figure:: img/location_licenses_layer_metadata.png - :align: center - - *Location and Licenses Metadata for Layers* - - The following list shows what kinds of metadata you are required to enter (see also the picture below): - - * The *Language* of the layer; - * The *License* of the dataset; - * The *Regions*, which informs on the spatial extent covered by the layer. Proposed extents cover the following scales: global, continental, regional, national; - * The *Data Quality statement* (general explanation of the data producer's knowledge about the lineage of a dataset); - * Potential *Restrictions* on layer sharing. - -* *Optional Metadata* - - .. figure:: img/optional_layer_metadata.png - :align: center - - *Optional Layer Metadata* - - Complementary information are: - - * The *Edition* to indicate the reference or the source of the layer; - * The *Purpose* of the layer and its objectives; - * Any *Supplemental information* that can provide a better understanding of the uploaded layer; - * The *Maintenance frequency* of the layer; - * The users who are *Responsible* for the layer, its *Owner*, and the *Author* of its metadata; - * The *Spatial representation type* used. - -* *Dataset Attributes* - - .. figure:: img/dataset_attributes_layer_metadata.png - :align: center - - *Dataset Attributes Metadata for Layers* - - At this step you can enrich the dataset attributes with useful information like the following: - - * The *Label* displayed - * A detailed *Description* - * The *Display Order* - -Use :guilabel:`next >>` or :guilabel:`<< back` to navigate through those steps. Once you have finished click on :guilabel:`Update`. - -Some metadata are mandatory, if you miss any of that metadata the *Completeness* bar shows you a red message like the one in the picture below. - -.. figure:: img/completeness_progress_bar.png - :align: center - :width: 200px - - *Completeness Progress Bar* - -Metadata Advanced Editing -------------------------- - -In the *Layer Editing* panel the :guilabel:`Advanced Edit` is also available. - -.. figure:: img/advanced_edit_button.png - :align: center - - *The Advanced Edit button* - -Click on it to display the *Metadata Advanced Editing Page*. That page allows you to edit all the layer metadata described in the previous paragraph. Once you have finished to edit them click on :guilabel:`Update` to save your changes. - -Uploading Metadata ------------------- - -Users may also upload a metadata XML document (in ISO, FGDC, or Dublin Core format) to fill in key GeoNode metadata elements automatically. -The picture below shows you how the page looks like. - -.. figure:: img/metadata_upload.png - :align: center - - *The Metadata Advanced Editing page* - -Click on :guilabel:`Choose Files` to select the document from your disk, then click on :guilabel:`Upload files` to trigger the uploading process. diff --git a/docs/usage/managing_layers/layer_permissions.rst b/docs/usage/managing_layers/layer_permissions.rst deleted file mode 100644 index 41038cf18a0..00000000000 --- a/docs/usage/managing_layers/layer_permissions.rst +++ /dev/null @@ -1,33 +0,0 @@ -.. _layer-permissions: - -Changing the Layer Permissions -============================== - -When creating or uploading a new Layer you have to set who can view, download, edit and manage that Layer. By default only owners can edit and manage layers, anyone can view and download them. - -In order to modify the Layer *Permissions* settings you have to click the :guilabel:`Change the Layer Permissions` button in the Layer page. - -.. figure:: img/change_layer_permissions.png - :align: center - - *Change Layer Permissions* - -Through the *Permissions Settings Panel* you can add or remove permissions for users and groups. The picture below shows an example. - -.. figure:: img/layer_permissions_settings.png - :align: center - - *Layer Permissions settings for users and groups* - -You can set the following types of permissions: - -* *View* allows to view the layer; -* *Download* allows to download the layer; -* *Change Metadata* allows to change the layer metadata; -* *Edit Data* allows to change attributes and properties of the layers features; -* *Edit Style* allows to change the layer style; -* *Manage* allows to update, delete, change permissions, publish and unpublish the layer. - -.. warning:: When assigning permissions to a group, all the group members will have those permissions. Be careful in case of editing permissions. - -Click on :guilabel:`Apply Changes` to save these settings. diff --git a/docs/usage/managing_layers/layer_styling.rst b/docs/usage/managing_layers/layer_styling.rst deleted file mode 100644 index 426a47e3429..00000000000 --- a/docs/usage/managing_layers/layer_styling.rst +++ /dev/null @@ -1,201 +0,0 @@ -.. _layer-style: - -Layer Styling -============= - -Maps are helpful because they allow you gain a deeper understanding of your data by allowing you to visualize it in many different ways. -So you can tell different stories depending on how the data is presented. -For any given data or layer, you should explore different styling options and choose the best style for that. - -In GeoNode each layer has a *Default Style* which is determined by the nature of the data you're mapping. When uploading a new layer (see :ref:`uploading-layers`) a new default style will be associated to it. - -.. figure:: img/layer_default_style.png - :align: center - - *Default Style for Layers* - -Referring to the example above, dark orange lines are not very good to represent waterways so we would need to change this style. In the following paragraphs you will learn how to create a new style starting from given templates, how to edit a style, how to upload styles from file and how to manage them. - -Creating new Styles -------------------- - -In order to create a new style, open the *Layer Page* (see :ref:`layer-info`) and click on :guilabel:`Editing Tools`. Then click the :guilabel:`Edit` button in the *Styles* section of the *Layer Editing* panel (see the picture below). - -.. figure:: img/edit_style_button.png - :align: center - - *Edit Styles button* - -The *Layer* will open in a new *Map*. The *Styles Panel* will show you all the available styles for the layer and some useful tools. - -.. figure:: img/styles_map_panel.png - :align: center - - *The Styles Panel in the Map* - -Now follow the steps below: - -1. Click the |create_new_style_button| button. The *Style Templates Panel* will open. - - .. |create_new_style_button| image:: img/create_new_style_button.png - :width: 30px - :height: 30px - :align: middle - - .. figure:: img/create_new_style_from_templates.png - :align: center - - *Create new Styles* - -2. Choose a *Style Template* from the list (both *CSS* and *SLD* styles are available). - - .. figure:: img/style_templates.png - :align: center - - *Style Templates* - -3. Click the |add_style_button| button to add the *Style Template* to the styles list. - - .. |add_style_button| image:: img/add_style_button.png - :width: 30px - :height: 30px - :align: middle - -4. Insert a *Title* and an *Abstract* (optional), then click on :guilabel:`Save`. - - .. figure:: img/new_style_title.png - :align: center - :width: 300px - - *Title and Abstract for new Styles* - -The style you have created is now added to the *Styles List*. - -.. figure:: img/new_style_in_list.png - :align: center - - *New Styles into the list* - -You will also see this new style in the *Layer Page*. - -.. figure:: img/new_style_in_layer_page.png - :align: center - - *The Layer Page with the new Style* - -Now you can switch the style by clicking on the corresponding checkbox. - -It would be nice to change the style in order to decrease the opacity of the filling color as well as to reduce the lines width. -The embedded `MapStore `_ makes available a powerful *Style Editor* to accomplish that tasks. In the next paragraph we will explain how. - -Editing the Layer Style ------------------------ - -The following steps show you how to edit styles: - -.. |toc_button| image:: img/toc_button.png - :width: 30px - :height: 30px - :align: middle - -.. |layer_settings_button| image:: img/layer_settings_button.png - :width: 30px - :height: 30px - :align: middle - -.. |style_tab| image:: img/style_tab.png - :width: 30px - :height: 30px - :align: middle - -.. |style_editor_button| image:: img/style_editor_button.png - :width: 30px - :height: 30px - :align: middle - -.. |save_style_button| image:: img/save_style_button.png - :width: 30px - :height: 30px - :align: middle - -.. |set_style_as_default_button| image:: img/set_style_as_default_button.png - :width: 30px - :height: 30px - :align: middle - -.. |delete_style_button| image:: img/delete_style_button.png - :width: 30px - :height: 30px - :align: middle - -1. From inside the map open the *TOC (Table Of Content)* by clicking the |toc_button| button -2. Click on |layer_settings_button| -3. Open the *Style* tab |style_tab| - - .. warning:: Styles editing is allowed only to those users who have the needed permission. See :ref:`layer-permissions` to read more) - -4. Select the *Style* and click on |style_editor_button| -5. Edit the style. The *Style Editor* helps you to write valid styles through the *Syntax Validator* which shows you a popup in case of errors (see the picture below). - - .. figure:: img/style_editor_syntax_validator.png - :align: center - - *The Style Editor Syntax Validation* - -6. Click on |save_style_button| to save your changes. - -See the following gif to recap the whole process. - -.. figure:: img/style_editor.gif - :align: center - - *The Style Editor* - -| You can also decide to make your new style the *Default Style* of that layer. Click on |set_style_as_default_button| to do that. -| Click on |delete_style_button| to delete the style. - -Uploading Styles ----------------- - -In GeoNode it is also possible to upload an existing style from file. - -.. warning:: Currently only styles in **SLD (Style Layer Descriptor 1.0, 1.1)** format can be uploaded in GeoNode. - -From the *Layer Page* click on *Editing Tools* to open the *Editing Tools* panel and follow the steps below: - -1. Click the :guilabel:`Upload` button of the *Styles* section - - .. figure:: img/upload_style_button.png - :align: center - :width: 400px - - *Upload Styles button* - -2. Click on :guilabel:`Choose Files` and select your style from your disk - - .. figure:: img/upload_styles.png - :align: center - - *Upload Styles* - -3. Click on :guilabel:`Upload files` - -Once the process has been finished the new *Style* will be visible in the *Layer Page*. - -Managing Styles ---------------- - -Given a layer, you can manage all its styles in tha *Styles Management Page* accessible from the :guilabel:`Manage` button of the *Layer Editing* panel. - -.. figure:: img/manage_styles.png - :align: center - - *Managing Styles* - -In that page you can: - -* See the *Layer Name* -* Add/remove styles to/from the *Available styles* list -* Choose the *Layer Default Style* from the *Available styles* list - -Click on :guilabel:`Update Available Styles` to save your changes. diff --git a/docs/usage/managing_layers/new_layer_from_scratch.rst b/docs/usage/managing_layers/new_layer_from_scratch.rst deleted file mode 100644 index e39b95942af..00000000000 --- a/docs/usage/managing_layers/new_layer_from_scratch.rst +++ /dev/null @@ -1,31 +0,0 @@ -Creating a Layer from scratch -============================= - -An interesting tool that GeoNode makes available to you is the *Create Layer*. It allows you to create a new vector layer from scratch. The *Layer Creation Form* is reachable through the :guilabel:`Create Layer` link shown in the picture below. - -.. figure:: img/create_layer_link.png - :align: center - - *Create layer link* - -In order to create the new Layer you have to fill out the required fields: - -* *Name* -* *Title* -* *Geometry type* - - .. figure:: img/geometry_types.png - :align: center - - *Geometry types* - -Usually the layers features should have some *Attributes* that enrich the amount of information associated with each of them. Through the :guilabel:`Add Attribute` button you can add new attributes. - -.. figure:: img/new_layer_from_scratch.gif - :align: center - - *New Layer creation from scratch* - -At this time you can also change the default *Permissions* settings, see :ref:`layer-permissions` to learn how. - -Once the form has been filled out, click on :guilabel:`Create`. You will be redirected to the *Layer Page* (see :ref:`layer-info`). Now your Layer is created but is still empty, no features have been added yet. See the :ref:`layer-editing` section to learn how to add new features. diff --git a/docs/usage/managing_layers/uploading_layers.rst b/docs/usage/managing_layers/uploading_layers.rst deleted file mode 100644 index dddcbd1a424..00000000000 --- a/docs/usage/managing_layers/uploading_layers.rst +++ /dev/null @@ -1,44 +0,0 @@ -.. _uploading-layers: - -Layers Uploading -================ - -| The most important resource type in GeoNode is the *Layer*. A layer represents spatial information so it can be displayed inside a map. -| To better understand what we are talking about let's upload your first layer. - -The *Layer Uploading* page can be reached from the :guilabel:`Upload Layer` link of the :guilabel:`Data` menu in the navigation bar. - -.. figure:: img/upload_layer_link.png - :align: center - - *Link for Layers Uploading* - -There is also an :guilabel:`Upload Layers` button in the *Layers Page*. - -.. figure:: img/upload_layer_link_from_list.png - :align: center - - *Button for Layers Uploading* - -The *Layers Uploading* page looks like the one in the picture below. - -.. figure:: img/layers_uploading_page.png - :align: center - - *The Layers Uploading page* - -| Through the :guilabel:`Choose Files` button you can select files from your disk, make sure they are valid raster or vector spatial data. You can also change the default *Permissions* settings (see :ref:`layer-permissions` for further information on how to set permissions). -| Select the *charset*, then click on :guilabel:`Upload files` to start the process or click :guilabel:`Clear` to remove all the loaded files form the page. - -.. figure:: img/upload_shapefile.gif - :align: center - - *Shapefile Uploading* - -In this example the ``roads`` ESRI Shapefile, with all its mandatory files (`.shp`, `.shx`, `.dbf` and `.prj`), has been chosen. -A progress bar shows the operation made during the layer upload and alerts you when the process is over. -When the process ends click the :guilabel:`Layer Info` to check the layer has been correctly uploaded. - -.. note:: There are lot of free spatial dataset available in the Internet. In this example, an extract of the Berlin city center roads map from the `BBBike extracts OpenStreetMap `_ dataset has been used. - -In the next paragraphs you will learn how to create a layer from scratch, how to set permissions, how to explore the layer properties and how to edit them. diff --git a/docs/usage/managing_layers/using_remote_services.rst b/docs/usage/managing_layers/using_remote_services.rst deleted file mode 100644 index 3477c2225e3..00000000000 --- a/docs/usage/managing_layers/using_remote_services.rst +++ /dev/null @@ -1,76 +0,0 @@ -Using Remote Services -===================== - -In GeoNode you can add new layers not only by loading them from your disk but also using *Remote Services*. -In this section you will learn how to add a new service and how to load resources in GeoNode through that. - -Let's try it! - -Click on the :guilabel:`Remote Services` link of the :guilabel:`Data` menu in the navigation bar. - -.. figure:: img/remote_services_link.png - :align: center - - *Remote Services link* - -The page that opens will contain the list of the available services. - -.. figure:: img/remote_services.png - :align: center - - *Remote Services* - -To configure a new service: - -* click on :guilabel:`Register a new Service` -* type the *Service URL* -* select the *Service Type* - - .. figure:: img/service_type.png - :align: center - - *Service Types* - -* click on :guilabel:`Create` - -GeoNode supports three **types of remote services**: - -* *Web Map Service* - - Generic Web Map Service (WMS) based on a standard protocol for serving georeferenced map images over the Internet. - These images are typically produced by a map server (like `GeoServer `_) from data provided by one or more distributed geospatial databases. - Common operations performed by a WMS service are: *GetCapabilities* (to retrieves metadata about the service, including supported operations and parameters, and a list of the available layers) and *GetMap* (to retrieves a map image for a specified area and content). - - .. note:: Lots of WMS services are available on the internet, in this example we used the ``https://demo.geo-solutions.it/geoserver/wms``. - -* *GeoNode Web Map Service* - - Generally a WMS is not directly invoked; client applications such as GIS-Desktop or WEB-GIS are used that provide the user with interactive controls. - A GeoNode WMS automatically performs some operations and lets you to immediately retrieve resources. - - .. note:: An example of GeoNode WMS is available at ``http://dev.geonode.geo-solutions.it/geoserver/wms``. - -* *ArcGIS REST MapServer* - - This map service provides basic information about the map, including the layers that it contains, whether the map is cached or not, its spatial reference, initial and full extents, whether the service is allowed to export tiles and max tiles export count, etc. - A set of operations that manage the state and contents of the service are allowed: Edit Service, Refresh, Update Tiles. - The URL should follow this pattern: ``https:///services//MapServer``. - - .. note:: Try the following service to better understand how it works: ``https://sampleserver6.arcgisonline.com/arcgis/rest/services/USA/MapServer``. - -Once the service has been configured, you can load the resources you are interested in through the *Import Resources* page where you will be automatically redirected to. -Take a look at the gif below to see the whole process. - -.. figure:: img/new_remote_service.gif - :align: center - - *A new Remote Service* - -| From the page where the services are listed, it is possible to click on the *Title* of a service. It opens the *Service Details* page. -| Each service has its own metadata such as the *Service Type*, the *URL*, an *Abstract*, some *Keywords* and the *Contact* user. - You can edit those metadata through the form available from the :guilabel:`Edit Service Metadata` button of the *Service Details* page (see the picture below). - -.. figure:: img/remote_service_metadata.png - :align: center - - *Remote Service metadata* diff --git a/docs/usage/managing_maps/creating_maps.rst b/docs/usage/managing_maps/creating_maps.rst deleted file mode 100644 index e041506511b..00000000000 --- a/docs/usage/managing_maps/creating_maps.rst +++ /dev/null @@ -1,81 +0,0 @@ -.. _creating-map: - -Creating Maps -============= - -In this section, we’ll create a *Map* using some uploaded layers, combine them with some other layers from remote web services, and then share the resulting map for public viewing. - -In order to create new maps you can use: - -* the :guilabel:`Create Map` link of the *Maps* menu in the navigation bar - - .. figure:: img/create_map_link.png - :align: center - - *The Create Map link* - -* the :guilabel:`Create Map` button in the *Layer Page* (it creates a map using a specific layer) - - .. figure:: img/create_map_button.png - :align: center - - *The Create Map button* - -* the :guilabel:`Create New Map` button in the *Explore Maps* page - - .. figure:: img/create_new_map_button.png - :align: center - - *The Create New Map button* - -The new *Map* will open in a *Map Viewer* like the one in the picture below. - -.. figure:: img/map_viewer.png - :align: center - - *The Map Viewer* - -.. |toc_button| image:: img/toc_button.png - :width: 30px - :height: 30px - :align: middle - -.. |burger_menu_button| image:: img/burger_menu_button.png - :width: 30px - :height: 30px - :align: middle - -.. |show_button| image:: img/show_button.png - :width: 30px - :height: 30px - :align: middle - -.. |hide_button| image:: img/hide_button.png - :width: 30px - :height: 30px - :align: middle - -.. |zoom_to_layer_extent_button| image:: img/zoom_to_layer_extent_button.png - :width: 30px - :height: 30px - :align: middle - -.. |layer_settings_button| image:: img/layer_settings_button.png - :width: 30px - :height: 30px - :align: middle - -| In the upper left corner the |toc_button| button opens the :ref:`toc` of the *Map*. It allows to manage all the layers associated with the map and to add new ones from the *Catalog*. -| The *TOC* component makes possible to manage layers overlap on the map by shifting their relative positions in the list (drag and drop them up or down in the list). -| It also allows to hide/show layers ( |show_button| and |hide_button| ), to zoom to layers extents ( |zoom_to_layer_extent_button| ) and to manage their properties ( |layer_settings_button| ). -| Once the map layers have been settled it is possible to save the *Map* by clicking on |burger_menu_button| and choosing :guilabel:`Save as`. - -.. figure:: img/new_map_creation.gif - :align: center - - *Creating new Maps* - -If you followed the steps above, you have just created your first *Map*. -Now you should see it in the *Explore Maps* page, see :ref:`map-info` for further details. - -We will take a closer look at the *Map Viewer* tools in the :ref:`exploring-maps` section. diff --git a/docs/usage/managing_maps/exploring_maps/attribute_table.rst b/docs/usage/managing_maps/exploring_maps/attribute_table.rst deleted file mode 100644 index 15de5bf6359..00000000000 --- a/docs/usage/managing_maps/exploring_maps/attribute_table.rst +++ /dev/null @@ -1,151 +0,0 @@ -.. _attributes-table: - -Attributes Table -================ - -.. |attribute_table_button| image:: img/attribute_table_button.png - :width: 30px - :height: 30px - :align: middle - -When clicking on the |attribute_table_button| button of the :ref:`toc`, the *Attributes Table* panel opens at the bottom of the *Map* page. - -.. figure:: img/attributes_table.png - :align: center - - *The Attributes Table Panel* - -.. |zoom_to_feature_icon| image:: img/zoom_to_feature_icon.png - :width: 30px - :height: 30px - :align: middle - -In that panel you can navigate through the features of the layer, zoom to their geometries by clicking on the |zoom_to_feature_icon| icon and explore their attributes. - -| The *Attribute Tables* has a row for each feature belonging to the layer and a column for each attribute that describes the feature. -| Each column has a *Filter* input field through which you can filter the features basing on some value or expression (depending on the data type of the field). - -.. figure:: img/filtering_feature_by_attributes.png - :align: center - - *Filtering Features by Attribute* - -The *Attributes Table* panel contains a *Toolbar* which makes you available some useful functionalities. - -.. figure:: img/attributes_table_toolbar.png - :align: center - - *The Attributes Table Toolbar* - -Those functionalities are: - -* | *Edit Mode* - | By clicking on |edit_mode_button| you can start an editing session. It permits you to add new features, to delete or modify the existing ones, to edit geometries. See the :ref:`layer-data-editing` section for further information. - - .. |edit_mode_button| image:: img/edit_mode_button.png - :width: 30px - :height: 30px - :align: middle - -* | *Advanced Search* - | Click on |advanced_search_button|, a new panel opens. That panel allows you to filter features in many different ways. This functionality will be explained in depth in the :ref:`advanced-search` section. - - .. |advanced_search_button| image:: img/advanced_search_button.png - :width: 30px - :height: 30px - :align: middle - -* | *Zoom to page extent* - | Click on |zoom_to_page_extent_button| to zoom to the page extent. - - .. |zoom_to_page_extent_button| image:: img/zoom_to_page_extent_button.png - :width: 30px - :height: 30px - :align: middle - -* | *Hide/show columns* - | When clicking on |hide_show_columns_button| another panel opens inside the *Attributes Table*. Through that panel you can choose what columns you want to see, see the picture below. - - .. figure:: img/hide_show_columns.gif - :align: center - - *Hide/Show Columns of the Attributes Table* - - .. |hide_show_columns_button| image:: img/hide_show_columns_button.png - :width: 30px - :height: 30px - :align: middle - -* | *Create a chart* - | Through the |create_charts_button| button you can open the *Chart Widgets* panel where many functionalities to describe and visualize the layer data are available (see :ref:`creating-widgets`). - - .. |create_charts_button| image:: img/create_charts_button.png - :width: 30px - :height: 30px - :align: middle - -* | *Sync map with filter* - | Click on the |sync_map_with_filter_button| icon to synchronize the map with the filter. - - .. |sync_map_with_filter_button| image:: img/sync_map_with_filter_button.png - :width: 30px - :height: 30px - :align: middle - -.. _advanced-search: - -Advanced Search ---------------- - -As mentioned before, GeoNode allows both an attribute based and spatial filtering. -When clicking on |advanced_search_button| from the layer *Attributes Table* the *Advanced Search* panel opens and shows you three different filtering functionalities: - -.. figure:: img/advanced_search.png - :align: center - - *Advanced Search* - -* In the **Attribute Filter** section you can compose a series of conditions about the attributes of the layer. - Click on |add_condition_button| to insert a new empty condition. - Select the attribute you are interested in, select an operator and type a comparison value. - You can group conditions through the *Add Group* |add_group_button| button. - Click on |start_search_button| to perform the search. - - .. figure:: img/filtering_by_attributes.png - :align: center - - *Filtering by Attributes* - - .. |add_condition_button| image:: img/add_condition_button.png - :width: 30px - :height: 30px - :align: middle - - .. |add_group_button| image:: img/add_group_button.png - :width: 30px - :height: 30px - :align: middle - - You can also decide if *All* the conditions have to be met, if only *Any* or *None* of them (see the red arrow in the picture above). - -* | The **Region of interest** filtering allows you to filter features that have some relationship with a spatial region that you draw on the map. - | Select the *Filter Type* (Circle, Viewport, Polygon or Rectangle), draw the spatial region of interest on the map, select a *Geometric Operation* (Intersects, Bounding Box, Contains or Is contained) and then click on |start_search_button|. - - .. figure:: img/filtering_region_of_interest.png - :align: center - - *Filtering by Region Of Interest* - - .. |start_search_button| image:: img/start_search_button.png - :width: 30px - :height: 30px - :align: middle - -* Through the **Layer Filter** you can select only those features which comply with some conditions on other layers of the map. You can also add conditions on attributes for those layers. - - .. figure:: img/layer_filtering.png - :align: center - - *Layer Filtering* - -You can read more about the *Attributes Table* and the *Advanced Search* on the `MapStore2 Documentation `_. diff --git a/docs/usage/managing_maps/exploring_maps/creating_widgets.rst b/docs/usage/managing_maps/exploring_maps/creating_widgets.rst deleted file mode 100644 index 0e39b6b6523..00000000000 --- a/docs/usage/managing_maps/exploring_maps/creating_widgets.rst +++ /dev/null @@ -1,124 +0,0 @@ -.. _creating-widgets: - -Creating Widgets -================ - -.. |create_widgets_button| image:: img/create_widgets_button.png - :width: 30px - :height: 30px - :align: middle - -*Widgets* are graphical elements that describe the layers data. They can be of different types such as *Charts*, *Texts*, *Tables* and *Counters*. -Through the |create_widgets_button| button of the :ref:`toc` you can open the *Widgets* panel. - -.. figure:: img/widgets_panel.png - :align: center - - *Creating Widgets* - -Chart Widgets -------------- - -*Chart Widgets* are graphical representations of the layer data. They can be *Bar Chart*, *Pie Chart* or *Line Chart* as shown in the picture below. - -.. figure:: img/chart_widgets.png - :align: center - - *Chart Widgets* - -.. |advanced_search_button| image:: img/advanced_search_button.png - :width: 30px - :height: 30px - :align: middle - -.. |configure_widgets_options_button| image:: img/configure_widgets_options_button.png - :width: 30px - :height: 30px - :align: middle - -.. |save_button| image:: img/save_button.png - :width: 30px - :height: 30px - :align: middle - -.. |connect_to_viewport| image:: img/connect_to_viewport.png - :width: 30px - :height: 30px - :align: middle - -| Let's create a new **Bar Chart**. -| Click on *Bar Chart* then select the *X Attribute*, the *Y Attribute*, the *Operation* and the *Color* do you prefer. - You can also display the *Legend*, *Hide the Y axis*, *Hide the grid* and decide what *Label* display into the legend. -| Now you can filter the data to be considered for the chart by clicking on |advanced_search_button|. We don't need any filter so click |configure_widgets_options_button| to configure other widget options. - Insert a *Title* and a *Description* and click on *Save* |save_button|. - -.. figure:: img/chart_widgets.gif - :align: center - - *Chart Widgets Creation* - -The green |connect_to_viewport| icon means that the chart is connected to the viewport. - -Expanding the options menu of the widget you can *Show the plotted data*, *Edit* the widget or *Delete* it, *Download* the data as a CSV file or *Export* the image of the graph. - -.. figure:: img/chart_widget_options.png - :align: center - :width: 500px - - *Chart Widgets Options* - -Text Widgets ------------- - -If you select *Text* on the *Widgets* panel you can create *Text Widgets*. Add a *Title* and the desired descriptive text, then click on |save_button|. - - -.. figure:: img/text_widgets_creation.png - :align: center - - *Text Widgets Creation* - -The resulting widget looks like the following. - -.. figure:: img/text_widget.png - :align: center - - *My Text Widget* - -Table Widgets -------------- - -| Through the *Table Widgets* you can add the :ref:`attributes-table` of the layer to the map. You can decide to show a subset of the features, through filters, and you can select one or more columns/attributes. -| So, choose what attributes you are interested in and click on |configure_widgets_options_button|. - -.. figure:: img/table_widget_columns.png - :align: center - - *Table Widgets Columns* - -Insert *Title* and *Description* (optional) and click on |save_button|. The example below shows the *Table Widget* on the map. - -.. figure:: img/table_widget.png - :align: center - - *Table Widget* - -Counter Widgets ---------------- - -*Counter Widgets* are numeric representations of some attributes. For example you can represent the average speed limit on a road network. - -.. figure:: img/counter_widget_creation.png - :align: center - :width: 400px - - *Counter Widget Creation* - -Click on |configure_widgets_options_button|, insert *Title* and *Description* then click on |save_button|. - -.. figure:: img/counter_widget.png - :align: center - - *Counter Widget* - -The GeoNode map viewer is `MapStore `_ based, see the `MapStore Documentation `_ for further information. diff --git a/docs/usage/managing_maps/exploring_maps/img/add_condition_button.png b/docs/usage/managing_maps/exploring_maps/img/add_condition_button.png deleted file mode 100644 index 240922d29c7..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/add_condition_button.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/add_group_button.png b/docs/usage/managing_maps/exploring_maps/img/add_group_button.png deleted file mode 100644 index a5a6d7dea3e..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/add_group_button.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/advanced_search.png b/docs/usage/managing_maps/exploring_maps/img/advanced_search.png deleted file mode 100644 index bd2644adff8..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/advanced_search.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/advanced_search_button.png b/docs/usage/managing_maps/exploring_maps/img/advanced_search_button.png deleted file mode 100644 index 1b2e41b5eeb..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/advanced_search_button.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/animation_buttons.png b/docs/usage/managing_maps/exploring_maps/img/animation_buttons.png deleted file mode 100644 index 8ec5034a9c2..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/animation_buttons.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/animation_settings_button.png b/docs/usage/managing_maps/exploring_maps/img/animation_settings_button.png deleted file mode 100644 index 58650034414..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/animation_settings_button.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/attribute_table_button.png b/docs/usage/managing_maps/exploring_maps/img/attribute_table_button.png deleted file mode 100644 index 1c8273645b3..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/attribute_table_button.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/attributes_table.png b/docs/usage/managing_maps/exploring_maps/img/attributes_table.png deleted file mode 100644 index 8885f059a21..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/attributes_table.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/attributes_table_toolbar.png b/docs/usage/managing_maps/exploring_maps/img/attributes_table_toolbar.png deleted file mode 100644 index ca44c71e1ef..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/attributes_table_toolbar.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/basemap_switcher.png b/docs/usage/managing_maps/exploring_maps/img/basemap_switcher.png deleted file mode 100644 index d6bf0298332..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/basemap_switcher.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/basemap_switching.gif b/docs/usage/managing_maps/exploring_maps/img/basemap_switching.gif deleted file mode 100644 index 037460a9335..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/basemap_switching.gif and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/chart_widget_options.png b/docs/usage/managing_maps/exploring_maps/img/chart_widget_options.png deleted file mode 100644 index ead2903674e..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/chart_widget_options.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/chart_widgets.gif b/docs/usage/managing_maps/exploring_maps/img/chart_widgets.gif deleted file mode 100644 index 5144d245e1c..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/chart_widgets.gif and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/chart_widgets.png b/docs/usage/managing_maps/exploring_maps/img/chart_widgets.png deleted file mode 100644 index 5325d1a1152..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/chart_widgets.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/collapsed_sidebar.png b/docs/usage/managing_maps/exploring_maps/img/collapsed_sidebar.png deleted file mode 100644 index aeb3edd2773..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/collapsed_sidebar.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/collapsed_timeline.png b/docs/usage/managing_maps/exploring_maps/img/collapsed_timeline.png deleted file mode 100644 index 247c10901b6..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/collapsed_timeline.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/configure_widgets_options_button.png b/docs/usage/managing_maps/exploring_maps/img/configure_widgets_options_button.png deleted file mode 100644 index 5e6b71de944..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/configure_widgets_options_button.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/connect_to_viewport.png b/docs/usage/managing_maps/exploring_maps/img/connect_to_viewport.png deleted file mode 100644 index 874a1965d2c..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/connect_to_viewport.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/counter_widget.png b/docs/usage/managing_maps/exploring_maps/img/counter_widget.png deleted file mode 100644 index 75e9d8644a5..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/counter_widget.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/counter_widget_creation.png b/docs/usage/managing_maps/exploring_maps/img/counter_widget_creation.png deleted file mode 100644 index fb96f2fd150..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/counter_widget_creation.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/create_charts_button.png b/docs/usage/managing_maps/exploring_maps/img/create_charts_button.png deleted file mode 100644 index f925825ab5d..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/create_charts_button.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/create_widgets_button.png b/docs/usage/managing_maps/exploring_maps/img/create_widgets_button.png deleted file mode 100644 index d601ddac28b..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/create_widgets_button.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/delete_layer.png b/docs/usage/managing_maps/exploring_maps/img/delete_layer.png deleted file mode 100644 index 547ba05687e..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/delete_layer.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/delete_layer_button.png b/docs/usage/managing_maps/exploring_maps/img/delete_layer_button.png deleted file mode 100644 index b3d109ebcb5..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/delete_layer_button.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/display_settings.png b/docs/usage/managing_maps/exploring_maps/img/display_settings.png deleted file mode 100644 index 17f69eb6f70..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/display_settings.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/edit_mode_button.png b/docs/usage/managing_maps/exploring_maps/img/edit_mode_button.png deleted file mode 100644 index a389a8d9f10..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/edit_mode_button.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/expand_timeline_button.png b/docs/usage/managing_maps/exploring_maps/img/expand_timeline_button.png deleted file mode 100644 index c9aebf49c2c..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/expand_timeline_button.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/expanded_sidebar.png b/docs/usage/managing_maps/exploring_maps/img/expanded_sidebar.png deleted file mode 100644 index 9d73060e4fe..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/expanded_sidebar.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/expanded_timeline.png b/docs/usage/managing_maps/exploring_maps/img/expanded_timeline.png deleted file mode 100644 index cb81f099573..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/expanded_timeline.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/explore_map_viewer.png b/docs/usage/managing_maps/exploring_maps/img/explore_map_viewer.png deleted file mode 100644 index 5f3cb4ba1bf..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/explore_map_viewer.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/filtering_by_attributes.png b/docs/usage/managing_maps/exploring_maps/img/filtering_by_attributes.png deleted file mode 100644 index 0f3ae937c9f..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/filtering_by_attributes.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/filtering_feature_by_attributes.png b/docs/usage/managing_maps/exploring_maps/img/filtering_feature_by_attributes.png deleted file mode 100644 index 940b541335e..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/filtering_feature_by_attributes.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/filtering_region_of_interest.png b/docs/usage/managing_maps/exploring_maps/img/filtering_region_of_interest.png deleted file mode 100644 index bc110d162b7..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/filtering_region_of_interest.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/full_screen_button.png b/docs/usage/managing_maps/exploring_maps/img/full_screen_button.png deleted file mode 100644 index 6dedff5aac2..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/full_screen_button.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/go_back_button.png b/docs/usage/managing_maps/exploring_maps/img/go_back_button.png deleted file mode 100644 index 5d6abda26e7..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/go_back_button.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/go_forward_button.png b/docs/usage/managing_maps/exploring_maps/img/go_forward_button.png deleted file mode 100644 index 068becb5ff0..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/go_forward_button.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/hide_show_columns.gif b/docs/usage/managing_maps/exploring_maps/img/hide_show_columns.gif deleted file mode 100644 index 8d82878fb76..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/hide_show_columns.gif and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/hide_show_columns_button.png b/docs/usage/managing_maps/exploring_maps/img/hide_show_columns_button.png deleted file mode 100644 index ec824ce1e23..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/hide_show_columns_button.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/layer_filtering.png b/docs/usage/managing_maps/exploring_maps/img/layer_filtering.png deleted file mode 100644 index e9002d06d74..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/layer_filtering.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/layer_settings_panel.png b/docs/usage/managing_maps/exploring_maps/img/layer_settings_panel.png deleted file mode 100644 index d96cd08e899..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/layer_settings_panel.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/layer_toolbar.png b/docs/usage/managing_maps/exploring_maps/img/layer_toolbar.png deleted file mode 100644 index d7f0fa07f72..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/layer_toolbar.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/layers_catalog.png b/docs/usage/managing_maps/exploring_maps/img/layers_catalog.png deleted file mode 100644 index 11de0d381fb..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/layers_catalog.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/map_coordinates.png b/docs/usage/managing_maps/exploring_maps/img/map_coordinates.png deleted file mode 100644 index e6d0f62c13d..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/map_coordinates.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/map_scale.png b/docs/usage/managing_maps/exploring_maps/img/map_scale.png deleted file mode 100644 index 4970648ecf2..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/map_scale.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/measure_tool.png b/docs/usage/managing_maps/exploring_maps/img/measure_tool.png deleted file mode 100644 index b4f3b93a605..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/measure_tool.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/measuring_areas.png b/docs/usage/managing_maps/exploring_maps/img/measuring_areas.png deleted file mode 100644 index 0facf8f2ee9..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/measuring_areas.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/my_map.png b/docs/usage/managing_maps/exploring_maps/img/my_map.png deleted file mode 100644 index ed92505c8bb..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/my_map.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/options_menu_tools.png b/docs/usage/managing_maps/exploring_maps/img/options_menu_tools.png deleted file mode 100644 index 3528b64736c..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/options_menu_tools.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/play_button.png b/docs/usage/managing_maps/exploring_maps/img/play_button.png deleted file mode 100644 index d5205f708e2..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/play_button.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/printing_window.png b/docs/usage/managing_maps/exploring_maps/img/printing_window.png deleted file mode 100644 index c6d983d2b3d..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/printing_window.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/query_objects_on_map_button.png b/docs/usage/managing_maps/exploring_maps/img/query_objects_on_map_button.png deleted file mode 100644 index 8af8069db02..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/query_objects_on_map_button.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/querying_objects_on_map.gif b/docs/usage/managing_maps/exploring_maps/img/querying_objects_on_map.gif deleted file mode 100644 index 718ec3191fa..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/querying_objects_on_map.gif and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/save_button.png b/docs/usage/managing_maps/exploring_maps/img/save_button.png deleted file mode 100644 index ccbc42a0d22..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/save_button.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/saving_map.png b/docs/usage/managing_maps/exploring_maps/img/saving_map.png deleted file mode 100644 index 4792e899a91..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/saving_map.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/scrolling_opacity.gif b/docs/usage/managing_maps/exploring_maps/img/scrolling_opacity.gif deleted file mode 100644 index e1f0dd84e33..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/scrolling_opacity.gif and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/search_bar_result.png b/docs/usage/managing_maps/exploring_maps/img/search_bar_result.png deleted file mode 100644 index 28c6b6bf026..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/search_bar_result.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/search_bar_typing_name.png b/docs/usage/managing_maps/exploring_maps/img/search_bar_typing_name.png deleted file mode 100644 index 6136fd4be79..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/search_bar_typing_name.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/show_hide_coordinates_button.png b/docs/usage/managing_maps/exploring_maps/img/show_hide_coordinates_button.png deleted file mode 100644 index 85243f1baca..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/show_hide_coordinates_button.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/show_hide_layers_list_button.png b/docs/usage/managing_maps/exploring_maps/img/show_hide_layers_list_button.png deleted file mode 100644 index dd7b1023329..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/show_hide_layers_list_button.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/sidebar_expand_button.png b/docs/usage/managing_maps/exploring_maps/img/sidebar_expand_button.png deleted file mode 100644 index 7d1858b5414..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/sidebar_expand_button.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/start_search_button.png b/docs/usage/managing_maps/exploring_maps/img/start_search_button.png deleted file mode 100644 index acabd829052..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/start_search_button.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/stop_button.png b/docs/usage/managing_maps/exploring_maps/img/stop_button.png deleted file mode 100644 index b9c5a27794a..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/stop_button.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/sync_map_with_filter_button.png b/docs/usage/managing_maps/exploring_maps/img/sync_map_with_filter_button.png deleted file mode 100644 index 26f992550a7..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/sync_map_with_filter_button.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/table_widget.png b/docs/usage/managing_maps/exploring_maps/img/table_widget.png deleted file mode 100644 index ca701b61864..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/table_widget.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/table_widget_columns.png b/docs/usage/managing_maps/exploring_maps/img/table_widget_columns.png deleted file mode 100644 index 91c7965b181..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/table_widget_columns.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/text_widget.png b/docs/usage/managing_maps/exploring_maps/img/text_widget.png deleted file mode 100644 index caeb3872891..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/text_widget.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/text_widgets_creation.png b/docs/usage/managing_maps/exploring_maps/img/text_widgets_creation.png deleted file mode 100644 index 0a6078ac48d..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/text_widgets_creation.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/time_cursor.png b/docs/usage/managing_maps/exploring_maps/img/time_cursor.png deleted file mode 100644 index 00690e1250b..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/time_cursor.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/time_go_backward_button.png b/docs/usage/managing_maps/exploring_maps/img/time_go_backward_button.png deleted file mode 100644 index 4fe73559fb6..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/time_go_backward_button.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/time_go_forward_button.png b/docs/usage/managing_maps/exploring_maps/img/time_go_forward_button.png deleted file mode 100644 index 9072190d269..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/time_go_forward_button.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/time_instant_controls.png b/docs/usage/managing_maps/exploring_maps/img/time_instant_controls.png deleted file mode 100644 index 0d9ac923f16..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/time_instant_controls.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/time_range.png b/docs/usage/managing_maps/exploring_maps/img/time_range.png deleted file mode 100644 index 2dafc313ad6..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/time_range.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/time_range_button.png b/docs/usage/managing_maps/exploring_maps/img/time_range_button.png deleted file mode 100644 index d099b6ee5b2..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/time_range_button.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/timeline_animation.gif b/docs/usage/managing_maps/exploring_maps/img/timeline_animation.gif deleted file mode 100644 index 59adb61d7c9..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/timeline_animation.gif and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/timeline_histogram.png b/docs/usage/managing_maps/exploring_maps/img/timeline_histogram.png deleted file mode 100644 index 596edfe59c7..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/timeline_histogram.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/timeline_settings.png b/docs/usage/managing_maps/exploring_maps/img/timeline_settings.png deleted file mode 100644 index 1e157c957dc..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/timeline_settings.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/toc_panel.png b/docs/usage/managing_maps/exploring_maps/img/toc_panel.png deleted file mode 100644 index 5de9e08b95c..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/toc_panel.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/view_map_button.png b/docs/usage/managing_maps/exploring_maps/img/view_map_button.png deleted file mode 100644 index 656ecebfe73..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/view_map_button.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/widgets_panel.png b/docs/usage/managing_maps/exploring_maps/img/widgets_panel.png deleted file mode 100644 index b3122d9f9f4..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/widgets_panel.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/zoom_in_button.png b/docs/usage/managing_maps/exploring_maps/img/zoom_in_button.png deleted file mode 100644 index 1df00a004d6..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/zoom_in_button.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/zoom_out_button.png b/docs/usage/managing_maps/exploring_maps/img/zoom_out_button.png deleted file mode 100644 index 8fb9fa117fe..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/zoom_out_button.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/zoom_to_feature_icon.png b/docs/usage/managing_maps/exploring_maps/img/zoom_to_feature_icon.png deleted file mode 100644 index 06f952ab34e..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/zoom_to_feature_icon.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/zoom_to_max_extent_button.png b/docs/usage/managing_maps/exploring_maps/img/zoom_to_max_extent_button.png deleted file mode 100644 index 2ba2c586e96..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/zoom_to_max_extent_button.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/img/zoom_to_page_extent_button.png b/docs/usage/managing_maps/exploring_maps/img/zoom_to_page_extent_button.png deleted file mode 100644 index 0e4c43d6614..00000000000 Binary files a/docs/usage/managing_maps/exploring_maps/img/zoom_to_page_extent_button.png and /dev/null differ diff --git a/docs/usage/managing_maps/exploring_maps/index.rst b/docs/usage/managing_maps/exploring_maps/index.rst deleted file mode 100644 index 25992c9f033..00000000000 --- a/docs/usage/managing_maps/exploring_maps/index.rst +++ /dev/null @@ -1,183 +0,0 @@ -.. _exploring-maps: - -Exploring Maps -============== - -From the :guilabel:`Explore Maps` link of the navigation bar you can reach the *Maps List* page (see :ref:`finding-maps`). -Select a map you are interested in and click on it, the *Map Page* will open. - -.. figure:: img/view_map_button.png - :align: center - - *The View Map button* - -Click on the :guilabel:`View Map` button to open the *Map Viewer*. - -.. figure:: img/explore_map_viewer.png - :align: center - - *The Map View* - -The Map Viewer (based on `MapStore `_) provides the following tools: - -* the :ref:`toc` to manage the map contents; -* the *Basemap Switcher* to change the basemap (see the next paragraphs); -* the *Search Bar* to search by location, name and coordinates (see the paragraph below); -* the :ref:`options-menu-tools` which contains the link to the *Print* tool, to the layers *Catalog* and to the *Measure* tool; -* the *Sidebar* and its tools such as the *Zoom* tools and the *Get Features Info* tool; -* the *Footer Tools* to manage the scale of the map, to track the mouse coordinates and change the CRS (Coordinates Reference System). - -.. toctree:: - :hidden: - :maxdepth: 1 - - toc - attribute_table - creating_widgets - timeline - options_menu - -Search Bar ----------- - -| The *Search Bar* of the map viewer allows you to find point of interests (POIs), streets or locations by name. -| Let's type the name of some place then select the first record. - -.. figure:: img/search_bar_typing_name.png - :align: center - - *The Search Bar* - -The map will automatically re-center on that area delimiting it by a polygon in the case of an area, by a line in the case of a linear shape (e.g. streets, streams) and by a marker in the case of a point. - -.. figure:: img/search_bar_result.png - :align: center - - *Result of a Search* - -.. _sidebar: - -Sidebar Tools -------------- - -.. |sidebar_expand_button| image:: img/sidebar_expand_button.png - :width: 30px - :height: 30px - :align: middle - -.. |zoom_in_button| image:: img/zoom_in_button.png - :width: 30px - :height: 30px - :align: middle - -.. |zoom_out_button| image:: img/zoom_out_button.png - :width: 30px - :height: 30px - :align: middle - -.. |query_objects_on_map_button| image:: img/query_objects_on_map_button.png - :width: 30px - :height: 30px - :align: middle - -.. |zoom_to_max_extent_button| image:: img/zoom_to_max_extent_button.png - :width: 30px - :height: 30px - :align: middle - -.. |go_back_button| image:: img/go_back_button.png - :width: 30px - :height: 30px - :align: middle - -.. |go_forward_button| image:: img/go_forward_button.png - :width: 30px - :height: 30px - :align: middle - -.. |full_screen_button| image:: img/full_screen_button.png - :width: 30px - :height: 30px - :align: middle - -.. |show_hide_coordinates_button| image:: img/show_hide_coordinates_button.png - :width: 30px - :height: 30px - :align: middle - -| The *Map Viewer* makes also available the *Sidebar*. - It is a navigation panel containing various tools that help you to explore the map such as tools for zooming, changing the extent and querying objects on the map. -| By default the *Sidebar* shows you the zooming buttons |zoom_in_button| and |zoom_out_button|, other options can be explored by clicking on |sidebar_expand_button| which expands/collapses the toolbar. - -.. figure:: img/collapsed_sidebar.png - :align: center - :width: 300px - - *The Default Sidebar* - -.. figure:: img/expanded_sidebar.png - :align: center - :width: 300px - - *The Expanded Sidebar* - -The *Sidebar* contains the following tools: - -* The *Query Objects on map* allows you to get feature information through the |query_objects_on_map_button| button. - It allows you to retrieve information about the features of some layers by clicking them directly on the map. - - .. figure:: img/querying_objects_on_map.gif - :align: center - - *Querying Objects on map* - - When clicking on map a new panel opens. That panel will show you all the information about the clicked features for each active loaded layer. - -* You can *Zoom To Max Extent* by clicking |zoom_to_max_extent_button|. - -* You can switch between the previous and the next zoom level through the *Go Back* button |go_back_button| and the *Go Forward* one |go_forward_button|. - -* The *Switch to Full Screen* |full_screen_button| button allows to have a full screen map. - -.. _basemap-switcher: - -Basemap Switcher ----------------- - -By deafault, GeoNode allows to enrich maps with many world backgrounds: - -* *OpenStreetMap* -* *OpenTopoMap* -* *Sentinel-2-cloudless* - -.. figure:: img/basemap_switcher.png - :align: center - :height: 400px - - *The Basemap Switcher Tool* - -You can also decide to have an *Empty Background*. - -.. figure:: img/basemap_switching.gif - :align: center - :height: 400px - - *Switching the Basemap* - -Footer Tools ------------- - -At the bottom of the map, the *Footer* shows you the *Scale* of the map and allows you to change it. - -.. figure:: img/map_scale.png - :align: center - :height: 600px - - *The Map Scale* - -The |show_hide_coordinates_button| button allows you to see the pointer *Coordinates* and to change the Coordinates Reference System (CRS), WGS 84 by default. - -.. figure:: img/map_coordinates.png - :align: center - - *The Pointer Coordinates and the CRS* diff --git a/docs/usage/managing_maps/exploring_maps/options_menu.rst b/docs/usage/managing_maps/exploring_maps/options_menu.rst deleted file mode 100644 index 61d0482ffb9..00000000000 --- a/docs/usage/managing_maps/exploring_maps/options_menu.rst +++ /dev/null @@ -1,102 +0,0 @@ -.. _options-menu-tools: - -Options Menu Tools -================== - -.. |burger_menu_button| image:: ../img/burger_menu_button.png - :width: 30px - :height: 30px - :align: middle - -At the top-right corner of the *Map* there is a *Burger Menu* button |burger_menu_button|. Click on it to open the *Map Options* panel. - -.. figure:: img/options_menu_tools.png - :align: center - - *The Map Options Menu* - -We will explain those tools more in depth in the next paragraphs. - -Printing a Map --------------- - -| The `MapStore `_ based map viewer of GeoNode allows you to print your map with a customizable layout. -| Click the :guilabel:`PRINT` option from the *Map Options Menu*, the **Printing Window** will open. - -.. figure:: img/printing_window.png - :align: center - - *The Printing Window* - -From this window you can: - -* enter *Title* and *Description*; -* choose the *Resolution* in dpi; -* customize the *Layout* - - + the *Sheet size* (A3, A4); - + if include the legend or not; - + if to put the legend in a separate page; - + the page *Orientation* (Landscape or Portrait); - -* customize the *Legend* - - + the *Label Font*; - + the *Font Size*; - + the *Font Emphasis* (bold, italic); - + if *Force Labels*; - + if use *Anti Aliasing Font*; - + the *Icon Size*; - + the *Legend Resolution* in dpi. - -To print the map click on :guilabel:`Print`. - -The Layers Catalog ------------------- - -All the layers available in GeoNode, both uploaded and remote, can be loaded on the map through the *Catalog*. -Click on the :guilabel:`CATALOG` option of the *Map Options Menu* to take a look at the catalog panel. - -.. figure:: img/layers_catalog.png - :align: center - - *The Layers Catalog* - -You can navigate through layers and look at their *Thumbnail* images, *Title*, *Description* and *Abstract*. -Click on :guilabel:`Add To Map` to load a layer into the map, it will be also visible in the :ref:`toc`. - -Performing Measurements ------------------------ - -Click on the :guilabel:`MEASURE` option of the *Map Options Menu* to perform a measurement. -As you can see in the picture below, this tool allows you to measure *Distances*, *Areas* and the *Bearing* of lines. - -.. figure:: img/measure_tool.png - :align: center - - *The Measure Tool* - -| To perform a measure draw on the map the geometry you are interested in, the result will be displayed on the left of the unit of measure select menu (this tool allows you to change the unit of measure also). - -.. figure:: img/measuring_areas.png - :align: center - - *Measuring Areas* - -Saving a map ------------- - -| Once all the customizations have been carried out, you can *Save* your map by clicking on the :guilabel:`SAVE AS` option of the *Map Options Menu*. -| A new popup window will open. - -.. figure:: img/saving_map.png - :align: center - - *Saving Maps* - -You have to fill out a *Title* and an optional *Description*, then click on :guilabel:`Save`. The page will reload and your map should be visible in the :ref:`finding-maps` list. - -.. figure:: img/my_map.png - :align: center - - *Your Map into the List* diff --git a/docs/usage/managing_maps/exploring_maps/timeline.rst b/docs/usage/managing_maps/exploring_maps/timeline.rst deleted file mode 100644 index 7532a3d88ad..00000000000 --- a/docs/usage/managing_maps/exploring_maps/timeline.rst +++ /dev/null @@ -1,131 +0,0 @@ -.. _timeline: - -Timeline -======== - -.. |expand_timeline_button| image:: img/expand_timeline_button.png - :width: 30px - :height: 30px - :align: middle - -.. |play_button| image:: img/play_button.png - :width: 30px - :height: 30px - :align: middle - -.. |time_go_backward_button| image:: img/time_go_backward_button.png - :width: 30px - :height: 30px - :align: middle - -.. |time_go_forward_button| image:: img/time_go_forward_button.png - :width: 30px - :height: 30px - :align: middle - -.. |stop_button| image:: img/stop_button.png - :width: 30px - :height: 30px - :align: middle - -.. |time_range_button| image:: img/time_range_button.png - :width: 30px - :height: 30px - :align: middle - -.. |show_hide_layers_list_button| image:: img/show_hide_layers_list_button.png - :width: 30px - :height: 30px - :align: middle - -.. |animation_settings_button| image:: img/animation_settings_button.png - :width: 30px - :height: 30px - :align: middle - -| GeoNode can manage layers with a *time dimension*. Those vector layer may vary their data through time so it is useful to represent that variation on the map. -| The `MapStore `_ based map viewer used in Geonode makes available the **Timeline** tool which allows you to observe the layers' evolution over time, to inspect the layer configuration at a specific time instant and to view different layer configurations time by time dynamically through animations (see the `MapStore Documentation `_ for further details). - -.. warning:: Timeline actually works only with WMTS-Multidim extension (WMS time in capabilities is not fully supported). - -When loading a temporal layer into the map, the *Timeline* opens automatically. - -.. figure:: img/collapsed_timeline.png - :align: center - - *The Timeline* - -On the left side of the *Timeline* panel you can set the time value in which you want to observe the data. You can type it directly filling out the corresponding input fields or by using the up/down arrows. - -.. figure:: img/time_instant_controls.png - :align: center - - *The Time Control Buttons* - -| On the other side there are the buttons responsible for managing the animations. -| In particular you can *Play* the animation by clicking |play_button|, go back to the previous time instant through |time_go_backward_button|, go forward to next time step using |time_go_forward_button| and stop the animation by clicking |stop_button|. - -.. figure:: img/animation_buttons.png - :align: center - - *The Animation Control Buttons* - -The *Timeline* panel can be expanded through the |expand_timeline_button| button. - -.. figure:: img/expanded_timeline.png - :align: center - - *The Expanded Timeline* - -The expanded section of the *Timeline* panel contains the *Time Layers List* and an *Histogram* which shows you: - -* the distribution of the data over time - - .. figure:: img/timeline_histogram.png - :align: center - - *The Timeline Histogram* - -* the *Time Cursor* - - .. figure:: img/time_cursor.png - :align: center - - *The Time Cursor* - -You can show/hide the layers list by clicking |show_hide_layers_list_button| (it is active by default). - -Through the *Time Range* function you can observe the data in a finite temporal interval. -Click on |time_range_button| and set the initial and the final times to use it. - -.. figure:: img/time_range.png - :align: center - - *The Time Range Settings* - -Animations ----------- - -| The *Timeline* allows you to see the data configurations (one for each time in which the data are defined) through ordered sequences of steps. -| As said before, you can play the resulting *Animation* by clicking the play button |play_button|. - The layer data displayed on map will change accordingly to the time reach by the cursor on the *Histogram*. - -By clicking on |animation_settings_button| you can manage some *Animation Settings*. - -.. figure:: img/timeline_settings.png - :align: center - :height: 400px - - *The Timeline Settings* - -| You can activate the *Snap to guide layer* so that the time cursor will snap to the selected layer's data. You can also set up the *Frame Duration* (by deafult 5 seconds). -| If the *Snap to guide layer* option is disabled, you can force the animation step to be a fixed value. - -The *Animation Range* option lets you to define a temporal range within which the time cursor can move. -See the following gif to better understand how the *Animation* works or take a look at the `MapStore Documentation `_. - -.. figure:: img/timeline_animation.gif - :align: center - :height: 400px - - *The Timeline Animation* diff --git a/docs/usage/managing_maps/exploring_maps/toc.rst b/docs/usage/managing_maps/exploring_maps/toc.rst deleted file mode 100644 index e94212268f7..00000000000 --- a/docs/usage/managing_maps/exploring_maps/toc.rst +++ /dev/null @@ -1,122 +0,0 @@ -.. _toc: - -Table of Contents (TOC) -======================= - -In the upper left corner, click on |toc_button| to open the *Table Of Contents*, briefly *TOC* from now on, of the map. -The *TOC* shows all the layers involved with the *Map* and allows to manage their properties and representations on the map. - -.. |toc_button| image:: ../img/toc_button.png - :width: 30px - :height: 30px - :align: middle - -.. |hide_button| image:: ../img/hide_button.png - :width: 30px - :height: 30px - :align: middle - -.. |show_button| image:: ../img/show_button.png - :width: 30px - :height: 30px - :align: middle - -.. figure:: img/toc_panel.png - :align: center - :height: 400px - - *The Table Of Contents (TOC)* - -From the *TOC* you can: - -* manage the layers *Overlap*; -* filter the layers list by typing text in the *Filter Layers* field; -* add new layers from the *Catalog* by clicking the :guilabel:`Add Layer` button; -* manage the layers properties such as *Opacity* (scroll the opacity cursor), *Visibility* (click on |hide_button| to make the layer not visible, click on |show_button| to show it on map); -* manage the *Layer Settings*, see the next paragraph. - -.. figure:: img/scrolling_opacity.gif - :align: center - :height: 400px - - *Scrolling the Layer Opacity* - -Select a *Layer* from the list and click on it, the *Layer Toolbar* should appear in the *TOC*. - -.. figure:: img/layer_toolbar.png - :align: center - :height: 400px - - *The Layer Toolbar* - -.. |zoom_to_layer_extent_button| image:: ../img/zoom_to_layer_extent_button.png - :width: 30px - :height: 30px - :align: middle - -.. |layer_settings_button| image:: ../img/layer_settings_button.png - :width: 30px - :height: 30px - :align: middle - -.. |attribute_table_button| image:: img/attribute_table_button.png - :width: 30px - :height: 30px - :align: middle - -.. |delete_layer_button| image:: img/delete_layer_button.png - :width: 30px - :height: 30px - :align: middle - -.. |create_widgets_button| image:: img/create_widgets_button.png - :width: 30px - :height: 30px - :align: middle - -The *Toolbar* shows you many buttons: - -* |zoom_to_layer_extent_button| allows you to zoom to the layer extent; -* |layer_settings_button| drives you through the layer settings customization (see the next paragraph); -* |attribute_table_button| to explore the features of the layer and their attributes (more information at :ref:`attributes-table`); -* |delete_layer_button| to delete layers (click on :guilabel:`Delete Layer` to confirm your choice); - - .. figure:: img/delete_layer.png - :align: center - - *Deleting Layers* - -* |create_widgets_button| to create *Widgets* (see :ref:`creating-widgets`). - -Managing Layer Settings ------------------------ - -The *Layer Settings* panel looks like the one below. - -.. figure:: img/layer_settings_panel.png - :align: center - :height: 400px - - *The Layer Settings Panel* - -The *Layer Settings* are divided in three groups: - -1. *General* settings -2. *Display* settings -3. *Style* settings - -In the **General** tab of the *Settings Panel* you can customize the layer *Title*, insert a *Description* and change/create the *Layer Group*. - -Click on the **Display** tab to see what are the layer appearance properties you can configure. - -.. figure:: img/display_settings.png - :align: center - :height: 400px - - *The Layer Display Settings Panel* - -| The *Format* field allows you to change the output format of the WMS requests. -| You can set a numeric value of *Opacity* using the corresponding input field. -| You can also set the layer as *Transparent*, decide to *Use cache options* and to use *Single Tile*. - -The third tab is the **Style** one. By clicking on it, an advanced *Style Editor* allows you to create new styles and to modify or delete an existing one. See the :ref:`layer-style` section to read more. diff --git a/docs/usage/managing_maps/img/advanced_edit_button.png b/docs/usage/managing_maps/img/advanced_edit_button.png deleted file mode 100644 index 47d6a178e01..00000000000 Binary files a/docs/usage/managing_maps/img/advanced_edit_button.png and /dev/null differ diff --git a/docs/usage/managing_maps/img/basic_map_metadata.png b/docs/usage/managing_maps/img/basic_map_metadata.png deleted file mode 100644 index 3481cc035ef..00000000000 Binary files a/docs/usage/managing_maps/img/basic_map_metadata.png and /dev/null differ diff --git a/docs/usage/managing_maps/img/burger_menu_button.png b/docs/usage/managing_maps/img/burger_menu_button.png deleted file mode 100644 index a914c5d02b7..00000000000 Binary files a/docs/usage/managing_maps/img/burger_menu_button.png and /dev/null differ diff --git a/docs/usage/managing_maps/img/change_map_permissions.png b/docs/usage/managing_maps/img/change_map_permissions.png deleted file mode 100644 index 06891bfe87b..00000000000 Binary files a/docs/usage/managing_maps/img/change_map_permissions.png and /dev/null differ diff --git a/docs/usage/managing_maps/img/completeness_progress_bar.png b/docs/usage/managing_maps/img/completeness_progress_bar.png deleted file mode 100644 index 47ac3712e24..00000000000 Binary files a/docs/usage/managing_maps/img/completeness_progress_bar.png and /dev/null differ diff --git a/docs/usage/managing_maps/img/create_map_button.png b/docs/usage/managing_maps/img/create_map_button.png deleted file mode 100644 index dc8c722e31e..00000000000 Binary files a/docs/usage/managing_maps/img/create_map_button.png and /dev/null differ diff --git a/docs/usage/managing_maps/img/create_map_link.png b/docs/usage/managing_maps/img/create_map_link.png deleted file mode 100644 index a552dc3f078..00000000000 Binary files a/docs/usage/managing_maps/img/create_map_link.png and /dev/null differ diff --git a/docs/usage/managing_maps/img/create_map_menu.png b/docs/usage/managing_maps/img/create_map_menu.png deleted file mode 100644 index 6bd06973ee0..00000000000 Binary files a/docs/usage/managing_maps/img/create_map_menu.png and /dev/null differ diff --git a/docs/usage/managing_maps/img/create_new_map_button.png b/docs/usage/managing_maps/img/create_new_map_button.png deleted file mode 100644 index 52066382a6a..00000000000 Binary files a/docs/usage/managing_maps/img/create_new_map_button.png and /dev/null differ diff --git a/docs/usage/managing_maps/img/favorite_map.png b/docs/usage/managing_maps/img/favorite_map.png deleted file mode 100644 index cfcf15fdd13..00000000000 Binary files a/docs/usage/managing_maps/img/favorite_map.png and /dev/null differ diff --git a/docs/usage/managing_maps/img/hide_button.png b/docs/usage/managing_maps/img/hide_button.png deleted file mode 100644 index 6f8a2f699f5..00000000000 Binary files a/docs/usage/managing_maps/img/hide_button.png and /dev/null differ diff --git a/docs/usage/managing_maps/img/layer_settings_button.png b/docs/usage/managing_maps/img/layer_settings_button.png deleted file mode 100644 index eda613606ef..00000000000 Binary files a/docs/usage/managing_maps/img/layer_settings_button.png and /dev/null differ diff --git a/docs/usage/managing_maps/img/location_licenses_map_metadata.png b/docs/usage/managing_maps/img/location_licenses_map_metadata.png deleted file mode 100644 index c27a3f61e0a..00000000000 Binary files a/docs/usage/managing_maps/img/location_licenses_map_metadata.png and /dev/null differ diff --git a/docs/usage/managing_maps/img/map_comments.png b/docs/usage/managing_maps/img/map_comments.png deleted file mode 100644 index 82812b2c659..00000000000 Binary files a/docs/usage/managing_maps/img/map_comments.png and /dev/null differ diff --git a/docs/usage/managing_maps/img/map_info.png b/docs/usage/managing_maps/img/map_info.png deleted file mode 100644 index dc46517208f..00000000000 Binary files a/docs/usage/managing_maps/img/map_info.png and /dev/null differ diff --git a/docs/usage/managing_maps/img/map_info_tab.png b/docs/usage/managing_maps/img/map_info_tab.png deleted file mode 100644 index 1155848256d..00000000000 Binary files a/docs/usage/managing_maps/img/map_info_tab.png and /dev/null differ diff --git a/docs/usage/managing_maps/img/map_metadata_detail_button.png b/docs/usage/managing_maps/img/map_metadata_detail_button.png deleted file mode 100644 index e34011dc405..00000000000 Binary files a/docs/usage/managing_maps/img/map_metadata_detail_button.png and /dev/null differ diff --git a/docs/usage/managing_maps/img/map_metadata_details_page.png b/docs/usage/managing_maps/img/map_metadata_details_page.png deleted file mode 100644 index 7b7f68845bc..00000000000 Binary files a/docs/usage/managing_maps/img/map_metadata_details_page.png and /dev/null differ diff --git a/docs/usage/managing_maps/img/map_permissions_settings.png b/docs/usage/managing_maps/img/map_permissions_settings.png deleted file mode 100644 index ef027d66641..00000000000 Binary files a/docs/usage/managing_maps/img/map_permissions_settings.png and /dev/null differ diff --git a/docs/usage/managing_maps/img/map_preview.gif b/docs/usage/managing_maps/img/map_preview.gif deleted file mode 100644 index 0db925b9cbb..00000000000 Binary files a/docs/usage/managing_maps/img/map_preview.gif and /dev/null differ diff --git a/docs/usage/managing_maps/img/map_rating.png b/docs/usage/managing_maps/img/map_rating.png deleted file mode 100644 index b8477037276..00000000000 Binary files a/docs/usage/managing_maps/img/map_rating.png and /dev/null differ diff --git a/docs/usage/managing_maps/img/map_sharing.png b/docs/usage/managing_maps/img/map_sharing.png deleted file mode 100644 index ec711c123e5..00000000000 Binary files a/docs/usage/managing_maps/img/map_sharing.png and /dev/null differ diff --git a/docs/usage/managing_maps/img/map_viewer.png b/docs/usage/managing_maps/img/map_viewer.png deleted file mode 100644 index b78f9bfcc6f..00000000000 Binary files a/docs/usage/managing_maps/img/map_viewer.png and /dev/null differ diff --git a/docs/usage/managing_maps/img/maps_add_layers_button.png b/docs/usage/managing_maps/img/maps_add_layers_button.png deleted file mode 100644 index d3185e53f1a..00000000000 Binary files a/docs/usage/managing_maps/img/maps_add_layers_button.png and /dev/null differ diff --git a/docs/usage/managing_maps/img/maps_layers_add_to_map.png b/docs/usage/managing_maps/img/maps_layers_add_to_map.png deleted file mode 100644 index 15e48d62989..00000000000 Binary files a/docs/usage/managing_maps/img/maps_layers_add_to_map.png and /dev/null differ diff --git a/docs/usage/managing_maps/img/maps_layers_button.png b/docs/usage/managing_maps/img/maps_layers_button.png deleted file mode 100644 index 71c119cd37d..00000000000 Binary files a/docs/usage/managing_maps/img/maps_layers_button.png and /dev/null differ diff --git a/docs/usage/managing_maps/img/maps_layers_switcher.png b/docs/usage/managing_maps/img/maps_layers_switcher.png deleted file mode 100644 index 88395aae051..00000000000 Binary files a/docs/usage/managing_maps/img/maps_layers_switcher.png and /dev/null differ diff --git a/docs/usage/managing_maps/img/maps_list.png b/docs/usage/managing_maps/img/maps_list.png deleted file mode 100644 index 0c6cacf464f..00000000000 Binary files a/docs/usage/managing_maps/img/maps_list.png and /dev/null differ diff --git a/docs/usage/managing_maps/img/maps_save_map_button.png b/docs/usage/managing_maps/img/maps_save_map_button.png deleted file mode 100644 index 849ab030ed5..00000000000 Binary files a/docs/usage/managing_maps/img/maps_save_map_button.png and /dev/null differ diff --git a/docs/usage/managing_maps/img/maps_save_map_thumbnail.png b/docs/usage/managing_maps/img/maps_save_map_thumbnail.png deleted file mode 100644 index 00e0ed82b45..00000000000 Binary files a/docs/usage/managing_maps/img/maps_save_map_thumbnail.png and /dev/null differ diff --git a/docs/usage/managing_maps/img/new_map_creation.gif b/docs/usage/managing_maps/img/new_map_creation.gif deleted file mode 100644 index a1f8ab9faf1..00000000000 Binary files a/docs/usage/managing_maps/img/new_map_creation.gif and /dev/null differ diff --git a/docs/usage/managing_maps/img/optional_map_metadata.png b/docs/usage/managing_maps/img/optional_map_metadata.png deleted file mode 100644 index 6cba37655b0..00000000000 Binary files a/docs/usage/managing_maps/img/optional_map_metadata.png and /dev/null differ diff --git a/docs/usage/managing_maps/img/show_button.png b/docs/usage/managing_maps/img/show_button.png deleted file mode 100644 index d0a991c1f12..00000000000 Binary files a/docs/usage/managing_maps/img/show_button.png and /dev/null differ diff --git a/docs/usage/managing_maps/img/toc.png b/docs/usage/managing_maps/img/toc.png deleted file mode 100644 index 9a98ba41e54..00000000000 Binary files a/docs/usage/managing_maps/img/toc.png and /dev/null differ diff --git a/docs/usage/managing_maps/img/toc_button.png b/docs/usage/managing_maps/img/toc_button.png deleted file mode 100644 index 6b15aac4626..00000000000 Binary files a/docs/usage/managing_maps/img/toc_button.png and /dev/null differ diff --git a/docs/usage/managing_maps/img/zoom_to_layer_extent_button.png b/docs/usage/managing_maps/img/zoom_to_layer_extent_button.png deleted file mode 100644 index 392ad743db4..00000000000 Binary files a/docs/usage/managing_maps/img/zoom_to_layer_extent_button.png and /dev/null differ diff --git a/docs/usage/managing_maps/index.rst b/docs/usage/managing_maps/index.rst deleted file mode 100644 index d717822c129..00000000000 --- a/docs/usage/managing_maps/index.rst +++ /dev/null @@ -1,16 +0,0 @@ -Managing Maps -============= - -| Maps are sets of layers displayed together on an interactive web map. - Maps can be composed in the map composer and saved as GeoNode resources. - Maps can also be associated with metadata, ratings, and comments. -| In this section, you will learn how to create a new map and share it. - -.. toctree:: - :maxdepth: 1 - - creating_maps - map_info - map_metadata - map_permissions - exploring_maps/index diff --git a/docs/usage/managing_maps/map_info.rst b/docs/usage/managing_maps/map_info.rst deleted file mode 100644 index 9d4f677f9fa..00000000000 --- a/docs/usage/managing_maps/map_info.rst +++ /dev/null @@ -1,94 +0,0 @@ -.. _map-info: - -Map Information -=============== - -| As mentioned in the :ref:`finding-maps` section, in GeoNode you can see your maps and all the published maps through the :guilabel:`Explore Maps` link of the navigation bar. -| Click on the title of the *Map* you are interested in to open its *Information* page, it should looks like the following. - -.. figure:: img/map_info.png - :align: center - - *The Map Information page* - -The *Map Page* is divided into three main sections: - -1. the *Map Preview* section, under the title -2. the *Tabs* section, under the layer preview -3. the *Tools* section, on the right side of the page - -Map Preview ------------ - -The *Map Preview* shows the *Map* with very basic functionalities: - -* the *Base Map Switcher* that allows you to change the base map; -* the *Zoom in/out* tool to enlarge and decrease the view; -* the *Zoom to max extent* tool for the zoom to fit the layers extents; -* the *Query Objects* tool to retrieve information about the map objects by clicking on the map; -* the *Print* tool to print the preview. - -.. figure:: img/map_preview.gif - :align: center - - *Map Preview* - -See the `MapStore Documentation `_ to learn more. - -Tabs Sections -------------- - -The *Map Information* page shows you some tabs sections containing different information about the map: - -* The tab *Info* is active by default. This tab section shows some metadata such as its Title, the License, the Publication Date etc. The metadata also indicates the map owner and which regions are involved. The ``Map Layers WMS GetCapabilities document`` link is also provided. - - .. figure:: img/map_info_tab.png - :align: center - - *Maps Info tab* - -* The *Share* tab provides the links for the map to share through social media or email. - - .. figure:: img/map_sharing.png - :align: center - - *Map Sharing* - -* You can *Rate* the map through the *Rating system*. - - .. figure:: img/map_rating.png - :align: center - - *Map Rating* - -* In the *Comments* tab section you can post your comment. Click on :guilabel:`Add Comment`, insert your comment and click :guilabel:`Submit Comment` to post it. - - .. figure:: img/map_comments.png - :align: center - - *Map Comments* - - Your comment will be added next to the last already existing comment. If you want to remove it click on the red :guilabel:`Delete` button. - - * If you want this map in your *Favorites* (see :ref:`editing-profile`), open the *Favorite* tab and click on :guilabel:`Add to Favorites`. - - .. figure:: img/favorite_map.png - :align: center - - *Your Favorite Maps* - -Map Tools ---------- - -| In the right side of the *Map Information* page there are some tools that can help you to manage your maps. - In this paragraph you will learn how to discover and retrieve information about maps. -| The following is a list of actions you can take in order to accomplish this task: - -* click the :guilabel:`Download Map` button, to download the map as image; -* click the :guilabel:`Metadata Detail` button to see the map metadata, see :ref:`map-metadata`; -* click the :guilabel:`Editing Tools` button to access to many editing tools. Those functionalities will be explained in the :ref:`exploring-maps` section; -* click the :guilabel:`View Map` button to open the map, see the :ref:`exploring-maps` section for more details; -* see the *Map Layers* section to konw which layers are used by the map (you can open the *Layer Page* by clicking on its name, available only for local layers); -* click the :guilabel:`Create a Map` button of the *Copy this map* section to duplicate the map; -* click the :guilabel:`Publish Map WMS` of the *Map WMS* section to publish local map layers as WMS layer group; -* see the *About* section to know the map *Owner*, the *Contact* user and the *Metadata Author*. diff --git a/docs/usage/managing_maps/map_metadata.rst b/docs/usage/managing_maps/map_metadata.rst deleted file mode 100644 index e87042e7430..00000000000 --- a/docs/usage/managing_maps/map_metadata.rst +++ /dev/null @@ -1,107 +0,0 @@ -.. _map-metadata: - -Maps Metadata -============= - -*Maps Metadata* can be explored by clicking the :guilabel:`Metadata Detail` button from the *Map Information* page. - -.. figure:: img/map_metadata_detail_button.png - :align: center - - *The Map Metadata Detail button* - -The *Map Metadata* page will open. - -.. figure:: img/map_metadata_details_page.png - :align: center - - *The Map Metadata Details* - -Lots of information are displayed in this page. Those information are grouped as follow: - - * *Identification* to uniquely identify the map (Title, License, Publication Date and Regions. There are also some flags which tell you the state of the map, in particular if it is Approved and/or Published); - * the map *Owner*; - * *Information*, the Identification Image, the Spatial Extent, the Projection System and the Extent; - * *Features*, Language, Supplemental and other Information; - * *Contact Points*, the available user to get in contact; - * *References*, links to the map and its metadata; - * *Metadata Author*, information about the author of the metadata. - -Metadata Wizard ---------------- - -| Metadata provide essential information for the identification and the comprehension of the map. They also make the map more easily retrievable through the search tools. -| Those *Metadata* can be filled out through a three-steps *Wizard* in which you have to provide all mandatory information to complete the process. Those three steps are described below. - -* *Basic Metadata* - - .. figure:: img/basic_map_metadata.png - :align: center - - *Basic Map Metadata* - - In the first step the system asks you to insert the following metadata (required fields are highlighted with red outlines): - - * The *Thumbnail* of the map (click :guilabel:`Edit` to change it); - * The *Title* of the map, which should be clear and understandable; - * An *Abstract*; - * The *Creation/Publication/Revision Dates* which define the time period that is covered by the map; - * The *Keywords*, which should be chosen within the available list; - * The *Category* which the map belongs to; - * The *Group* which the map is linked to. - - Click :guilabel:`Next >>` to go to the next step. - -* *Location and Licenses* - - .. figure:: img/location_licenses_map_metadata.png - :align: center - - *Location and Licenses Metadata for Maps* - - The following list shows what kinds of metadata you are required to enter (see also the picture below): - - * The *Language* of the layer; - * The *License* of the dataset; - * The *Regions* covered by the layers extent. Proposed extents cover the following scales: global, continental, regional, national; - * The *Data Quality statement* (general explanation of the data producer's knowledge about the lineage of a dataset); - * Potential *Restrictions* on layer sharing. - - No further mandatory metadata are required in the next step so, once the required fields have been filled out, a green :guilabel:`Done` button will be visible in the screen. - Click :guilabel:`Next >>` to go to the next step or :guilabel:`<< Back` to go back to the previous step. - -* *Optional Metadata* - - .. figure:: img/optional_map_metadata.png - :align: center - - *Optional Map Metadata* - - Complementary information are: - - * The *Edition* of the map; - * The *Purpose* of the map and its objectives; - * Any *Supplemental information* that can provide a better understanding of the map; - * The *Maintenance frequency* of the map; - * The *Spatial representation type*, the method used to represent geographic information in the dataset; - * The users who are *Responsible* for the layer, its *Owner*, and the *Author* of its metadata; - -If you miss some mandatory metadata the *Completeness* bar shows you a red message like the one in the picture below. - -.. figure:: img/completeness_progress_bar.png - :align: center - :width: 200px - - *Completeness Progress Bar* - -Metadata Advanced Editing -------------------------- - -The :guilabel:`Advanced Edit` editing tool allows to change the map metadata. You can find this button into the map *Editing Tools*. - -.. figure:: img/advanced_edit_button.png - :align: center - - *The Advanced Edit button* - -Click on it to display the *Metadata Advanced Editing Page*. That page allows you to edit all the layer metadata described in the previous paragraph. Once you have finished to edit them click on :guilabel:`Update` to save your changes. diff --git a/docs/usage/managing_maps/map_permissions.rst b/docs/usage/managing_maps/map_permissions.rst deleted file mode 100644 index 94471fc6a4a..00000000000 --- a/docs/usage/managing_maps/map_permissions.rst +++ /dev/null @@ -1,36 +0,0 @@ -.. _map-permissions: - -Changing the Map Permissions -============================ - -In the :ref:`map-info` section of this guide we said that you can see your maps and all the published maps. -In GeoNode the permissions management system is indeed more complex. -Administrators can choose who can do what for each map. -Users can manage only the maps they own or the maps which they are authorize to manage. - -By default only owners can edit and manage maps, anyone can view and download them. - -In order to modify the *Map Permissions* settings you have to click the :guilabel:`Change the Layer Permissions` button in the *Map Page*. - -.. figure:: img/change_map_permissions.png - :align: center - - *Change Map Permissions* - -Through the *Permissions Settings Panel* you can add or remove permissions for users and groups. The picture below shows an example. - -.. figure:: img/map_permissions_settings.png - :align: center - - *Map Permissions settings for users and groups* - -You can set the following types of permissions: - -* *View* allows to view the map; -* *Download* allows to download the map; -* *Change Metadata* allows to change the map metadata; -* *Manage* allows to update, delete, change permissions, publish and unpublish the map. - -.. warning:: When assigning permissions to a group, all the group members will have those permissions. Be careful in case of editing permissions. - -Click on :guilabel:`Apply Changes` to save these settings. diff --git a/docs/usage/other_apps/index.rst b/docs/usage/other_apps/index.rst deleted file mode 100644 index 21f98ca8e6e..00000000000 --- a/docs/usage/other_apps/index.rst +++ /dev/null @@ -1,4 +0,0 @@ -Using GeoNode with Other Applications -===================================== - -Your GeoNode project is based on core components which are interoperable and as such, it is straightforward for you to integrate with external applications and services. This section will walk you through how to connect to your GeoNode instance from other applications and how to integrate other services into your GeoNode project. When complete, you should have a good idea about the possibilities for integration, and have basic knowledge about how to accomplish it. You may find it necessary to dive deeper into how to do more complex integration in order to accomplish your goals, but you should feel comfortable with the basics, and feel confident reaching out to the wider GeoNode community for help. diff --git a/docs/usage/publishing_data/img/map_embed.png b/docs/usage/publishing_data/img/map_embed.png deleted file mode 100644 index ddea6e5bbb5..00000000000 Binary files a/docs/usage/publishing_data/img/map_embed.png and /dev/null differ diff --git a/docs/usage/publishing_data/img/map_url.png b/docs/usage/publishing_data/img/map_url.png deleted file mode 100644 index 0fb4041e3b1..00000000000 Binary files a/docs/usage/publishing_data/img/map_url.png and /dev/null differ diff --git a/docs/usage/publishing_data/index.rst b/docs/usage/publishing_data/index.rst deleted file mode 100644 index 00a012bc8ff..00000000000 --- a/docs/usage/publishing_data/index.rst +++ /dev/null @@ -1,36 +0,0 @@ -Publishing Data -=============== - -In GeoNode, each resource can be published in order to share it with other people. -Once a *Map* has been published you can embed it in your web pages, your blog or your web site. - -An easy way to accomplish that is to use an ``iframe``. See the following steps: - -* Open the :ref:`map-info` page and copy the *URL* - - .. figure:: img/map_url.png - :align: center - - *The Map Infromation Page URL* - -* Add *"/embed"* to the URL so that it will be like this *"http://master.demo.geonode.org/maps/11/embed"* - -* Use this URL inside an html ``iframe`` as ``src`` value - - .. code-block:: html - - - -* Put this html block of code inside your web pages to display the map. - -Saving an html file with this code you can test your map on your pc, look at the following picture. - -.. figure:: img/map_embed.png - :align: center - - *The Embedded Map* - -As you can see, some basic functionalities will be available to the user: the :ref:`toc`, the :ref:`basemap-switcher`, the :ref:`sidebar` and the :ref:`options-menu-tools`. diff --git a/docs/usage/users_groups/contacting_users.rst b/docs/usage/users_groups/contacting_users.rst deleted file mode 100644 index 54c4716de96..00000000000 --- a/docs/usage/users_groups/contacting_users.rst +++ /dev/null @@ -1,60 +0,0 @@ -Contacting other users -====================== - -| GeoNode allows you to communicate by message with other registered users and groups. -| To send a message to some user and/or groups you can follow the link :guilabel:`Message User` from your *Profile* page (see :ref:`editing-profile`) or from the *Profile* details page (see the previous section :ref:`user-info`) of that user. - -.. figure:: img/write_message.png - :align: center - - *Send message to users and groups* - -| Insert your content, type a subject and click on :guilabel:`Send message` to send the message to the users and groups you have selected. -| You will be redirected to the *Conversation* details page related to the subject. - -.. figure:: img/sent_message.png - :align: center - - *Your message* - -The Inbox page --------------- - -You can view your conversations in your *Inbox* page, reachable through the :guilabel:`Back to inbox` button (see the picture above) or from the :guilabel:`Inbox` link of the user menu. - -.. figure:: img/inbox_link.png - :align: center - - *Inbox link* - -The picture below shows how your *Inbox* page should look like. - -.. figure:: img/inbox_page.png - :align: center - - *Inbox page* - -In *Inbox* all the unread messages are listed. You haven't received any message yet so your *Inbox* is empty. If you switch to the *All* tab you can see all the conversations you are involved in. - -.. figure:: img/all_your_conversations.png - :align: center - - *All your conversations* - -When some user send a reply to your message your *Inbox* shows it, see the picture below for an example. - -.. figure:: img/reply_inbox.png - :align: center - - *A reply to your message* - -You can open the *Conversation* details by clicking on the *Subject* link. - -.. figure:: img/conversation.png - :align: center - - *Conversation details* - -As you can see in the picture above, in the *Conversation* page you have the ability to write a quick reply. Type your message in the text box and click on :guilabel:`Send Reply` to do that. - -In the *Inbox* page there is also the :guilabel:`Create Message` button that provides you a quick link to the message creation form. diff --git a/docs/usage/users_groups/img/all_your_conversations.png b/docs/usage/users_groups/img/all_your_conversations.png deleted file mode 100644 index 75edbeb33c1..00000000000 Binary files a/docs/usage/users_groups/img/all_your_conversations.png and /dev/null differ diff --git a/docs/usage/users_groups/img/conversation.png b/docs/usage/users_groups/img/conversation.png deleted file mode 100644 index d58f44a5f1f..00000000000 Binary files a/docs/usage/users_groups/img/conversation.png and /dev/null differ diff --git a/docs/usage/users_groups/img/inbox_link.png b/docs/usage/users_groups/img/inbox_link.png deleted file mode 100644 index 184107b946e..00000000000 Binary files a/docs/usage/users_groups/img/inbox_link.png and /dev/null differ diff --git a/docs/usage/users_groups/img/inbox_page.png b/docs/usage/users_groups/img/inbox_page.png deleted file mode 100644 index 9e2690581f6..00000000000 Binary files a/docs/usage/users_groups/img/inbox_page.png and /dev/null differ diff --git a/docs/usage/users_groups/img/invite_users.png b/docs/usage/users_groups/img/invite_users.png deleted file mode 100644 index 05379af3338..00000000000 Binary files a/docs/usage/users_groups/img/invite_users.png and /dev/null differ diff --git a/docs/usage/users_groups/img/invite_users_confirm.png b/docs/usage/users_groups/img/invite_users_confirm.png deleted file mode 100644 index 7e1301e6368..00000000000 Binary files a/docs/usage/users_groups/img/invite_users_confirm.png and /dev/null differ diff --git a/docs/usage/users_groups/img/people_link.png b/docs/usage/users_groups/img/people_link.png deleted file mode 100644 index 25349c8051e..00000000000 Binary files a/docs/usage/users_groups/img/people_link.png and /dev/null differ diff --git a/docs/usage/users_groups/img/recent_activities.png b/docs/usage/users_groups/img/recent_activities.png deleted file mode 100644 index fb712e81c15..00000000000 Binary files a/docs/usage/users_groups/img/recent_activities.png and /dev/null differ diff --git a/docs/usage/users_groups/img/recent_activities_link.png b/docs/usage/users_groups/img/recent_activities_link.png deleted file mode 100644 index 264744417dc..00000000000 Binary files a/docs/usage/users_groups/img/recent_activities_link.png and /dev/null differ diff --git a/docs/usage/users_groups/img/registered_users_list.png b/docs/usage/users_groups/img/registered_users_list.png deleted file mode 100644 index 87ee6224a6b..00000000000 Binary files a/docs/usage/users_groups/img/registered_users_list.png and /dev/null differ diff --git a/docs/usage/users_groups/img/reply_inbox.png b/docs/usage/users_groups/img/reply_inbox.png deleted file mode 100644 index bd5c1b152ba..00000000000 Binary files a/docs/usage/users_groups/img/reply_inbox.png and /dev/null differ diff --git a/docs/usage/users_groups/img/sent_message.png b/docs/usage/users_groups/img/sent_message.png deleted file mode 100644 index cde808d396a..00000000000 Binary files a/docs/usage/users_groups/img/sent_message.png and /dev/null differ diff --git a/docs/usage/users_groups/img/user_activities.png b/docs/usage/users_groups/img/user_activities.png deleted file mode 100644 index e7df836c553..00000000000 Binary files a/docs/usage/users_groups/img/user_activities.png and /dev/null differ diff --git a/docs/usage/users_groups/img/user_details.png b/docs/usage/users_groups/img/user_details.png deleted file mode 100644 index 0c1b860deac..00000000000 Binary files a/docs/usage/users_groups/img/user_details.png and /dev/null differ diff --git a/docs/usage/users_groups/img/write_message.png b/docs/usage/users_groups/img/write_message.png deleted file mode 100644 index d6712164da7..00000000000 Binary files a/docs/usage/users_groups/img/write_message.png and /dev/null differ diff --git a/docs/usage/users_groups/index.rst b/docs/usage/users_groups/index.rst deleted file mode 100644 index bbf640dacc7..00000000000 --- a/docs/usage/users_groups/index.rst +++ /dev/null @@ -1,29 +0,0 @@ -Interacting with Users and Groups -================================= - -The GeoNode platform allows you to communicate by message with other GeoNode users and groups of users. - -| You can also invite external users to join your GeoNode. In order to do that, click on :guilabel:`Invite Users` in the *Profile* page (see :ref:`editing-profile`) or in the :guilabel:`About` menu in the *Home* page. -| You can invite your contacts typing their email addresses in the input field as shown in the picture below. Click on :guilabel:`Submit` to perform the action. - -.. figure:: img/invite_users.png - :align: center - - *Invite users to join GeoNode* - -A message will confirm that invitations have been correctly sent. - -.. figure:: img/invite_users_confirm.png - :align: center - - *Invitations confirm message* - -.. note:: You can invite more than one user at the same time by typing the email addresses inline with a semi-colon separator. - -The next sections will show you how to view information about other users and how to contact them. - -.. toctree:: - :maxdepth: 1 - - users_info - contacting_users diff --git a/docs/usage/users_groups/users_info.rst b/docs/usage/users_groups/users_info.rst deleted file mode 100644 index bcb8a8d26ef..00000000000 --- a/docs/usage/users_groups/users_info.rst +++ /dev/null @@ -1,54 +0,0 @@ -.. _user-info: - -Viewing other users information -=============================== - -| Once your account is created, you can view other accounts on the system. -| To see information about other users on the system, click the :guilabel:`People` link of the :guilabel:`About` menu in *Home* page. - -.. figure:: img/people_link.png - :align: center - - *About menu - People link* - -You will see a list of users registered on the system. - -.. figure:: img/registered_users_list.png - :align: center - - *List of the registered users* - -| The *Search* tool is very useful in case of many registered users, type the name of the user you are looking for in the input text field to filter the users list. -| Select a user and click on its *username* to access to the user details page. - -.. figure:: img/user_details.png - :align: center - - *User details* - -In this page the main information about the user are shown: personal information (name, surname, organization and so on...) and the resources the user owns (layers, maps and documents). - -Through the :guilabel:`User Activities` link, in right side of the page, it is possible to visualize all the activities the user has been done. - -.. figure:: img/user_activities.png - :align: center - - *User activities* - -The :guilabel:`Message User` link lets you to contact other users, see the next section to read more about that. - -It is also possible, in GeoNode, to see the recent activities of all users through the :guilabel:`Recent Activities` link of the user menu. - -.. figure:: img/recent_activities_link.png - :align: center - - *Recent Activities link* - -In the picture below an example. - -.. figure:: img/recent_activities.png - :align: center - - *Recent Activities* - -As you can see, you can decide whether to see only the activities related to layers or those related to maps or comments by switching the tabs. diff --git a/geonode/templates/index.html b/geonode/templates/index.html index 4827f7061b9..f884392418e 100644 --- a/geonode/templates/index.html +++ b/geonode/templates/index.html @@ -21,7 +21,7 @@

    {{custom_theme.jumbotron_welcome_title|default:_("Welcome")}}

    {{custom_theme.jumbotron_welcome_content|default:_("GeoNode is an open source platform for sharing geospatial data and maps.")}}

    {% if not custom_theme.jumbotron_cta_hide %}

    {{custom_theme.jumbotron_cta_text|default:_("Get Started »")}}

    {% endif %} diff --git a/requirements_docs.txt b/requirements_docs.txt deleted file mode 100644 index cd0359fee2b..00000000000 --- a/requirements_docs.txt +++ /dev/null @@ -1,3 +0,0 @@ -sphinx==2.4.3 -sphinx_rtd_theme==0.4.3 -readthedocs-sphinx-ext==1.0.1