Skip to content

Commit

Permalink
- Update pip install instructions on docs and README
Browse files Browse the repository at this point in the history
  • Loading branch information
afabiani committed May 24, 2018
1 parent 914ccb2 commit b21a0b8
Show file tree
Hide file tree
Showing 10 changed files with 55 additions and 55 deletions.
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ install:
- sudo apt-get install -y --force-yes oracle-java8-installer ant maven2 --no-install-recommends
- sudo update-java-alternatives --set java-8-oracle
- pip install -r requirements.txt
- pip install -e .
- pip install -e . --upgrade
- pip install pygdal==`gdal-config --version`
- pip install codecov

Expand Down
8 changes: 4 additions & 4 deletions README
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ Or if you want to use the provided Makefile::

# complete development setup
make develop

.. note:: For development you need to add ``geonode`` alias into ``/etc/hosts/`` file as following::

$ sudo vim /etc/hosts
Expand Down Expand Up @@ -108,8 +108,8 @@ Ubuntu development build instructions using an isolated virtual environment (tes
cd geonode

# Install pip dependencies
pip install -r requirements.txt --no-deps
pip install -e .
pip install -r requirements.txt
pip install -e . --upgrade --no-cache
pip install pygdal==1.11.3.3

For Ubuntu 16.04 you should create your virtual-env like this instead (so with site packages)::
Expand Down Expand Up @@ -278,7 +278,7 @@ Mac OSX Development Build Instructions::
npm install -g grunt-cli

#Install pip dependencies
pip install -e .
pip install -e . --upgrade --no-cache

#Paver handles dependencies for Geonode, first setup (this will download and update your python dependencies - ensure you're in a virtualenv)
paver setup
Expand Down
8 changes: 4 additions & 4 deletions docs/organizational/contribute/README
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ Or if you want to use the provided Makefile::

# complete development setup
make develop

.. note:: For development you need to add ``geonode`` alias into ``/etc/hosts/`` file as following::

$ sudo vim /etc/hosts
Expand Down Expand Up @@ -102,8 +102,8 @@ Ubuntu development build instructions using an isolated virtual environment (tes
cd geonode

# Install pip dependencies
pip install -r requirements.txt --no-deps
pip install -e .
pip install -r requirements.txt
pip install -e . --upgrade --no-cache
pip install pygdal==1.11.3.3

For Ubuntu 16.04 you should create your virtual-env like this instead (so with site packages)::
Expand Down Expand Up @@ -266,7 +266,7 @@ Mac OSX Development Build Instructions::
npm install -g grunt-cli

#Install pip dependencies
pip install -e .
pip install -e . --upgrade --no-cache

#Paver handles dependencies for Geonode, first setup (this will download and update your python dependencies - ensure you're in a virtualenv)
paver setup
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ If you are working remotely, you should first connect to the machine that has yo

.. code-block:: console
:linenos:

$ apt-get install python-django
$ django-admin startproject my_geonode --template=https://github.com/GeoNode/geonode-project/archive/master.zip -epy,rst
$ cd my_geonode
$ sudo pip install -e .
$ sudo pip install -e . --upgrade --no-cache
$ python manage.py migrate

.. note:: You should NOT use the name *geonode* for your project as it will conflict with your default geonode package name.
Expand All @@ -25,11 +25,11 @@ Make sure that the directories are reachable and have the correct rights for the

.. code-block:: console
:linenos:

$ sudo chown -Rf geonode: *
$ sudo chmod -Rf 775 my_geonode

If you have a brand new installation of GeoNode, rename the **/home/geonode/geonode/local_settings.py.sample** to **local_settings.py** and edit it's content by setting the SITEURL and SITENAME. This file will be your main settings file for your project. It inherits all the settings from the original one plus you can override the ones that you need.
If you have a brand new installation of GeoNode, rename the **/home/geonode/geonode/local_settings.py.sample** to **local_settings.py** and edit it's content by setting the SITEURL and SITENAME. This file will be your main settings file for your project. It inherits all the settings from the original one plus you can override the ones that you need.

.. note:: You can also decide to copy the **/home/geonode/geonode/local_settings.py.sample** to **/path/to/my_geonode/my_geonode/local_settings.py** in order to keep all the custom settings confined into the new project.

Expand Down Expand Up @@ -82,7 +82,7 @@ Edit the file /etc/apache2/sites-available/geonode.conf and modify the **Documen
Allow from all
IndexOptions FancyIndexing
</Directory>

...

Then regenerate the static **JavaScript** and **CSS** files from **/path/to/my_geonode/** and restart apache
Expand Down Expand Up @@ -144,7 +144,7 @@ It is recommended that you immediately put your new project under source code re
:linenos:

$ sudo git remote add origin <https url of your custom repo>


#. Add your project files to the repository:

Expand All @@ -161,7 +161,7 @@ It is recommended that you immediately put your new project under source code re
# Those two command must be issued ONLY once
$ sudo git config --global user.email "my@email"
$ sudo git config --global user.name "myuser"

$ sudo git commit -am "Initial commit"

#. Push to the remote repository:
Expand Down Expand Up @@ -237,7 +237,7 @@ python module may not be available) is:

.. code-block: python
:linenos:

try:
from local_settings import *
except:
Expand Down
22 changes: 11 additions & 11 deletions docs/tutorials/admin/install/custom_install.txt
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ This includes:
* Python development libraries
* PostgreSQL database
* The GDAL, GEOS, and OGR geospatial software libraries

For detailed information on dependencies please refer to the section :ref:`dependencies`.

For convenience, appropriate commands to retrieve these dependencies on Ubuntu
Expand Down Expand Up @@ -100,7 +100,7 @@ installation-configuration of GeoNode:
#. `Configure using the ubuntu config file`_.
This is the recommended way, using the provided .sh scripts
#. `Configure manually`_, doing each step by hand as opposed to using the .sh scripts

In the end you will have the same running instance of Geonode.

Configure Manually
Expand All @@ -120,7 +120,7 @@ Download the code using git.
$ cd geonode

# Installs django etc.
$ sudo pip install -e .
$ sudo pip install -e . --upgrade --no-cache

# Downloads geoserver.war
$ sudo paver setup
Expand Down Expand Up @@ -192,7 +192,7 @@ To create the databases (the geonode one and the spatial for shapefile imports):
$ psql -d geonode_data -c 'GRANT ALL ON spatial_ref_sys TO PUBLIC;'
$ exit

This creates databases called *geonode* and *geonode_data*
This creates databases called *geonode* and *geonode_data*
(which automatically has the postgis extension as well!)
with owner *geonode*.

Expand Down Expand Up @@ -491,7 +491,7 @@ pre-installed.
However, some manual configuration may still be needed in case of not standard
installation.

**Configure GeoServer**
**Configure GeoServer**

Configure GeoServer with the location of the GeoNode site, used for
authentication (so that GeoServer can recognize logins from the main site).
Expand All @@ -508,12 +508,12 @@ so:
<context-param>
<param-name>GEONODE_BASE_URL</param-name>
<param-value>http://localhost/</param-value>
</context-param>
</context-param>

The ``<param-value>`` tag should enclose the URL to the Django application
homepage.

And secondly, update the value of the ``baseUrl`` tag in
And secondly, update the value of the ``baseUrl`` tag in
``data/security/auth/geonodeAuthProvider/config.xml``:

.. code-block:: xml
Expand Down Expand Up @@ -544,16 +544,16 @@ Download the code using git.
$ git clone https://github.com/GeoNode/geonode.git
$ cd geonode

* Installer configuration file *(located in ``package/support/config-ubuntu.sh``)*
* Installer configuration file *(located in ``package/support/config-ubuntu.sh``)*
This is the first thing to edit.
* The installer script *(located in ``package/install.sh``)*
Second thing to edit.

#. First open the ``package/support/config-ubuntu.sh`` installer configuration file.
Now provide the details of your installation,
such as where your web server looks for documents.

#. Second, open ``install.sh`` and configure to your needs.
#. Second, open ``install.sh`` and configure to your needs.

.. note:: you might have to change the postgresql and postgis versions in
this file, according to the versions you use!
Expand All @@ -573,6 +573,6 @@ Once edited (if necessary) run the ``./install.sh`` file with the following comm

# create the IP address to your address
$ sudo geonode-updateip youraddress


GeoNode can now be accessed at http://localhost
26 changes: 13 additions & 13 deletions docs/tutorials/admin/socialaccounts/index.txt
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Base concepts and objects
* `django-invitations <https://github.com/bee-keeper/django-invitations>`_ has also been integrated as a dependency of geonode and is used for managing invitations to new users. This functionality was previously provided by geonode-user-accounts;

* `django-allauth <http://django-allauth.readthedocs.io/en/latest/>`_ has been extended in order to provide the following additional features:

- Automatically registering an e-mail with a user when the e-mail is used to connect to a social account;
- Automatically extract information from the user's social account and use that to enhance the user's profile fields on geonode. This was implemented in a pluggable way, allowing custom installs to configure it for other providers;
- Allow approval of new registrations by staff members before allowing new users to login. This functionality was previously provided by geonode-user-accounts.
Expand All @@ -33,7 +33,7 @@ Base concepts and objects
.. image:: img/001_screenshot.png

* When properly configured, the login and register pages now display the possibility to login with social accounts

.. image:: img/002_screenshot.png


Expand All @@ -45,7 +45,7 @@ Installation
.. code:: python

pip install -r requirements.txt
pip install -e .
pip install -e . --upgrade --no-cache
pip uninstall geonode-user-accounts -y
pip uninstall django-user-accounts -y

Expand Down Expand Up @@ -157,9 +157,9 @@ Usage
This will require a persoanl or business account, which can access to the ``developers`` sections of LinkedIn and Facebook and create and configure new ``Applications``.

That account won't be visibile to the GeoNode users. This is needed only to generate OAuth2 ``Client ID`` and ``Client Secret`` Authorization Keys.

In the following sections we will see in details how to configure them for both LinkedIn and Facebook.

LinkedIn Application
++++++++++++++++++++
(ref.: http://django-allauth.readthedocs.io/en/latest/providers.html)
Expand Down Expand Up @@ -188,10 +188,10 @@ LinkedIn Application
5. Add OAuth 2.0 Authorized Redirect URLs:

.. code:: python

http://geonode.geo-solutions.it/account/linkedin_oauth2/login/callback/
http://geonode.geo-solutions.it/account/linkedin/login/callback/

.. image:: img/008_socialaouth.png

6. Save
Expand Down Expand Up @@ -243,10 +243,10 @@ Facebook Application
5. Cut and Paste the ``App ID`` and ``Secret Key`` on the related fields

.. code:: python

ClientID <--> App Id
Client Secret <--> Secret Key

.. image:: img/018_socialaouth.png

6. Save
Expand Down Expand Up @@ -298,7 +298,7 @@ Facebook Application
18. Add the valid ``redirect URIs``:

.. code:: python

http://geonode.geo-solutions.it/account/facebook/login/callback/
http://geondoe.geo-solutions.it/account/login/

Expand All @@ -312,9 +312,9 @@ Login by using Existing Accounts on GeoNode
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

If you want to enable an already existing user account to login through social apps, you need to associate it to social accounts.

Usually this could be done only by the current user, since this operation requires authentication on its social accounts.

In order to do that you need to go to the User Profile Settings

.. image:: img/032_socialaouth.png
Expand All @@ -325,7 +325,7 @@ Login by using Existing Accounts on GeoNode
.. image:: img/033_socialaouth.png

And actually connect them

.. image:: img/034_socialaouth.png

.. image:: img/035_socialaouth.png
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ packages
.. code-block:: bash

$ sudo apt-get update

$ sudo apt-get install python-virtualenv python-dev libxml2 libxml2-dev libxslt1-dev zlib1g-dev libjpeg-dev libpq-dev git default-jdk
$ sudo apt-get install build-essential openssh-server gettext nano vim unzip zip patch git-core postfix

Expand All @@ -50,7 +50,7 @@ packages
$ sudo apt-get install gcc apache2 libapache2-mod-wsgi libgeos-dev libjpeg-dev libpng-dev libpq-dev libproj-dev libxml2-dev libxslt-dev
$ sudo apt-add-repository ppa:ubuntugis/ubuntugis-testing && sudo apt-get update && sudo apt-get upgrade
$ sudo apt-get install gdal-bin libgdal20 libgdal-dev
$ sudo apt-get install python-gdal python-pycurl python-imaging python-pastescript python-psycopg2 python-urlgrabber
$ sudo apt-get install python-gdal python-pycurl python-imaging python-pastescript python-psycopg2 python-urlgrabber
$ sudo apt-get install postgresql postgis postgresql-9.5-postgis-scripts postgresql-contrib
$ sudo apt-get install tomcat8

Expand Down Expand Up @@ -101,7 +101,7 @@ First of all we need to prepare a new Python Virtual Environment:
Let's activate the new `geonode` Python Virtual Environment:

.. code-block:: bash

$ workon geonode

Move into the `geonode` home folder
Expand All @@ -113,12 +113,12 @@ Move into the `geonode` home folder
We are going to install GeoNode as a dependency of a **Customized DJango Project**

.. note::
A custom project is a DJango application with *ad hoc* configuration and folders, which allows you to
A custom project is a DJango application with *ad hoc* configuration and folders, which allows you to
extend the original **GeoNode** code without actually dealing or modifying the main source code.

This will allow you to easily customize your GeoNode instance, modify the theme, add new functionalities and so on,
and also being able to keep updated with the GeoNode latest source code.

For more deails please check https://github.com/GeoNode/geonode-project/tree/master

.. code-block:: bash
Expand All @@ -132,7 +132,7 @@ Let's install the GeoNode dependencies and packages into the Python Virtual Envi

$ cd my_geonode

# Find the closest pygdal version.
# Find the closest pygdal version.
# Example: 2.2.1 ... 2.2.1.3, ...
$ gdal-config --version && pip install pygdal==

Expand All @@ -143,7 +143,7 @@ Let's install the GeoNode dependencies and packages into the Python Virtual Envi
pygdal==2.2.1.3

$ pip install -r requirements.txt
$ pip install -e .
$ pip install -e . --upgrade --no-cache


In the next section we are going to setup PostgreSQL Databases for GeoNode and finalize the setup
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Upgrade Development Environment

pip install pip --upgrade
pip install -r requirements.txt
pip install -e .
pip install -e . --upgrade --no-cache

# WARNING: your GDAL version might be different. Use the right one accordingly to gdal-config --version
pip install pygdal==2.2.1.3
Expand Down

0 comments on commit b21a0b8

Please sign in to comment.