{"title":"GeoDjango Installation","version":"3.0","locale":"ko","docname":"ref/contrib/gis/install/index","url":"/ko/3.0/ref/contrib/gis/install/","canonical":"https://djangodocs.dev/ko/3.0/ref/contrib/gis/install/","summary":"Overview Link to this heading # In general, GeoDjango installation requires: Python and Django Spatial database Installing Geospatial libraries Details for each of…","html":"

GeoDjango InstallationLink to this heading#

\n
\n

OverviewLink to this heading#

\n

In general, GeoDjango installation requires:

\n
    \n

  1. Python and Django

    2. \n

  2. Spatial database

    3. \n

  3. Installing Geospatial libraries

    4. \n
\n

Details for each of the requirements and installation instructions\nare provided in the sections below. In addition, platform-specific\ninstructions are available for:

\n\n\n
\n
\n

RequirementsLink to this heading#

\n
\n

Python and DjangoLink to this heading#

\n

Because GeoDjango is included with Django, please refer to Django’s\ninstallation instructions for details on\nhow to install.

\n
\n
\n

Spatial databaseLink to this heading#

\n

PostgreSQL (with PostGIS), MySQL (mostly with MyISAM engine), Oracle, and SQLite\n(with SpatiaLite) are the spatial databases currently supported.

\n\n

The geospatial libraries required for a GeoDjango installation depends\non the spatial database used. The following lists the library requirements,\nsupported versions, and any notes for each of the supported database backends:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Database

Library Requirements

Supported Versions

Notes

PostgreSQL

GEOS, GDAL, PROJ.4, PostGIS

9.5+

Requires PostGIS.

MySQL

GEOS, GDAL

5.6.1+

Limited functionality.

Oracle

GEOS, GDAL

12.2+

XE not supported.

SQLite

GEOS, GDAL, PROJ.4, SpatiaLite

3.8.3+

Requires SpatiaLite 4.3+

\n
\n

See also this comparison matrix on the OSGeo Wiki for\nPostgreSQL/PostGIS/GEOS/GDAL possible combinations.

\n
\n
\n
\n

InstallationLink to this heading#

\n
\n

Geospatial librariesLink to this heading#

\n
\n\n
\n
\n
\n

Database installationLink to this heading#

\n
\n\n
\n
\n
\n

DATABASES configurationLink to this heading#

\n

Set the ENGINE setting to one of the spatial\nbackends.

\n
\n
\n

Add django.contrib.gis to INSTALLED_APPSLink to this heading#

\n

Like other Django contrib applications, you will only need to add\ndjango.contrib.gis to INSTALLED_APPS in your settings.\nThis is so that the gis templates can be located – if not done, then\nfeatures such as the geographic admin or KML sitemaps will not function properly.

\n
\n
\n
\n

TroubleshootingLink to this heading#

\n

If you can’t find the solution to your problem here then participate in the\ncommunity! You can:

\n\n
\n

Library environment settingsLink to this heading#

\n

By far, the most common problem when installing GeoDjango is that the\nexternal shared libraries (e.g., for GEOS and GDAL) cannot be located. [1]\nTypically, the cause of this problem is that the operating system isn’t aware\nof the directory where the libraries built from source were installed.

\n

In general, the library path may be set on a per-user basis by setting\nan environment variable, or by configuring the library path for the entire\nsystem.

\n
\n

LD_LIBRARY_PATH environment variableLink to this heading#

\n

A user may set this environment variable to customize the library paths\nthey want to use. The typical library directory for software\nbuilt from source is /usr/local/lib. Thus, /usr/local/lib needs\nto be included in the LD_LIBRARY_PATH variable. For example, the user\ncould place the following in their bash profile:

\n
Shell
export LD_LIBRARY_PATH=/usr/local/lib\n
\n
\n
\n

Setting system library pathLink to this heading#

\n

On GNU/Linux systems, there is typically a file in /etc/ld.so.conf, which may include\nadditional paths from files in another directory, such as /etc/ld.so.conf.d.\nAs the root user, add the custom library path (like /usr/local/lib) on a\nnew line in ld.so.conf. This is one example of how to do so:

\n
Shell
$ sudo echo /usr/local/lib >> /etc/ld.so.conf\n$ sudo ldconfig\n
\n

For OpenSolaris users, the system library path may be modified using the\ncrle utility. Run crle with no options to see the current configuration\nand use crle -l to set with the new library path. Be very careful when\nmodifying the system library path:

\n
Shell
# crle -l $OLD_PATH:/usr/local/lib\n
\n
\n
\n

Install binutilsLink to this heading#

\n

GeoDjango uses the find_library function (from the ctypes.util Python\nmodule) to discover libraries. The find_library routine uses a program\ncalled objdump (part of the binutils package) to verify a shared\nlibrary on GNU/Linux systems. Thus, if binutils is not installed on your\nLinux system then Python’s ctypes may not be able to find your library even if\nyour library path is set correctly and geospatial libraries were built perfectly.

\n

The binutils package may be installed on Debian and Ubuntu systems using the\nfollowing command:

\n
Shell
$ sudo apt-get install binutils\n
\n

Similarly, on Red Hat and CentOS systems:

\n
Shell
$ sudo yum install binutils\n
\n
\n
\n
\n
\n

Platform-specific instructionsLink to this heading#

\n
\n

macOSLink to this heading#

\n

Because of the variety of packaging systems available for macOS, users have\nseveral different options for installing GeoDjango. These options are:

\n\n

This section also includes instructions for installing an upgraded version\nof Python from packages provided by the Python Software\nFoundation, however, this is not required.

\n
\n

PythonLink to this heading#

\n

Although macOS comes with Python installed, users can use framework\ninstallers provided by the Python Software Foundation. An advantage to\nusing the installer is that macOS’s Python will remain “pristine” for internal\noperating system use.

\n\n
\n
\n

Postgres.appLink to this heading#

\n

Postgres.app is a standalone PostgreSQL server\nthat includes the PostGIS extension. You will also need to install gdal and\nlibgeoip with Homebrew.

\n

After installing Postgres.app, add the following to your .bash_profile so\nyou can run the package’s programs from the command-line. Replace X.Y with\nthe version of PostgreSQL in the Postgres.app you installed:

\n
Shell
export PATH=$PATH:/Applications/Postgres.app/Contents/Versions/X.Y/bin\n
\n

You can check if the path is set up correctly by typing which psql at a\nterminal prompt.

\n
\n
\n

HomebrewLink to this heading#

\n

Homebrew provides “recipes” for building binaries and packages from source.\nIt provides recipes for the GeoDjango prerequisites on Macintosh computers\nrunning macOS. Because Homebrew still builds the software from source, Xcode\nis required.

\n

Summary:

\n
Shell
$ brew install postgresql\n$ brew install postgis\n$ brew install gdal\n$ brew install libgeoip\n
\n
\n
\n

KyngChaos packagesLink to this heading#

\n

William Kyngesburye provides a number of geospatial library binary packages\nthat help to get GeoDjango installed on macOS without compiling them from\nsource. However, Xcode is still necessary for compiling the Python database\nadapters psycopg2 (for PostGIS).

\n\n

Download the framework packages for:

\n
    \n

  • UnixImageIO

    • \n

  • PROJ

    • \n

  • GEOS

    • \n

  • SQLite3 (includes the SpatiaLite library)

    • \n

  • GDAL

    • \n
\n

Install the packages in the order they are listed above, as the GDAL and SQLite\npackages require the packages listed before them.

\n

Afterwards, you can also install the KyngChaos binary packages for PostgreSQL\nand PostGIS.

\n

After installing the binary packages, you’ll want to add the following to\nyour .profile to be able to run the package programs from the command-line:

\n
Shell
export PATH=/Library/Frameworks/UnixImageIO.framework/Programs:$PATH\nexport PATH=/Library/Frameworks/PROJ.framework/Programs:$PATH\nexport PATH=/Library/Frameworks/GEOS.framework/Programs:$PATH\nexport PATH=/Library/Frameworks/SQLite3.framework/Programs:$PATH\nexport PATH=/Library/Frameworks/GDAL.framework/Programs:$PATH\nexport PATH=/usr/local/pgsql/bin:$PATH\n
\n
\n
psycopg2Link to this heading#
\n

After you’ve installed the KyngChaos binaries and modified your PATH, as\ndescribed above, psycopg2 may be installed using the following command:

\n
Shell
$ python -m pip install psycopg2\n
\n\n
\n
\n
FinkLink to this heading#
\n

Kurt Schwehr has been gracious enough to create GeoDjango packages for users\nof the Fink package system. Different packages are available (starting\nwith django-gis), depending on which version of Python you want to use.

\n
\n
\n
\n

MacPortsLink to this heading#

\n

MacPorts may be used to install GeoDjango prerequisites on computers\nrunning macOS. Because MacPorts still builds the software from source,\nXcode is required.

\n

Summary:

\n
Shell
$ sudo port install postgresql93-server\n$ sudo port install geos\n$ sudo port install proj\n$ sudo port install postgis\n$ sudo port install gdal +geos\n$ sudo port install libgeoip\n
\n\n
\n
\n
\n

WindowsLink to this heading#

\n

Proceed through the following sections sequentially in order to install\nGeoDjango on Windows.

\n
\n

PythonLink to this heading#

\n

Install Python.

\n
\n
\n

PostgreSQLLink to this heading#

\n

First, download the latest PostgreSQL 9.x installer from the\nEnterpriseDB website. After downloading, run the installer, follow the\non-screen directions, and keep the default options unless you know the\nconsequences of changing them.

\n\n

When the installer completes, it will ask to launch the Application Stack\nBuilder (ASB) on exit – keep this checked, as it is necessary to\ninstall PostGIS.

\n\n
\n
\n

PostGISLink to this heading#

\n

From within the Application Stack Builder (to run outside of the installer,\nStart ‣ Programs ‣ PostgreSQL 9.x), select\nPostgreSQL Database Server 9.x on port 5432 from the drop down\nmenu. Next, expand the Categories ‣ Spatial Extensions menu\ntree and select PostGIS X.Y for PostgreSQL 9.x.

\n

After clicking next, you will be prompted to select your mirror, PostGIS\nwill be downloaded, and the PostGIS installer will begin. Select only the\ndefault options during install (e.g., do not uncheck the option to create a\ndefault PostGIS database).

\n\n
\n
\n

psycopg2Link to this heading#

\n

The psycopg2 Python module provides the interface between Python and the\nPostgreSQL database. Download the latest Windows installer for your version\nof Python and PostgreSQL and run using the default settings. [2]

\n
\n
\n

OSGeo4WLink to this heading#

\n

The OSGeo4W installer helps to install the PROJ.4, GDAL, and GEOS libraries\nrequired by GeoDjango. First, download the OSGeo4W installer, and run it.\nSelect Express Web-GIS Install and click next. In the ‘Select\nPackages’ list, ensure that GDAL is selected; MapServer and Apache are also\nenabled by default, but are not required by GeoDjango and may be unchecked\nsafely. After clicking next, the packages will be automatically downloaded and\ninstalled, after which you may exit the installer.

\n
\n
\n

Modify Windows environmentLink to this heading#

\n

In order to use GeoDjango, you will need to add your Python and OSGeo4W\ndirectories to your Windows system Path, as well as create GDAL_DATA\nand PROJ_LIB environment variables. The following set of commands,\nexecutable with cmd.exe, will set this up:

\n
Bat
set OSGEO4W_ROOT=C:\\OSGeo4W\nset PYTHON_ROOT=C:\\Python3X\nset GDAL_DATA=%OSGEO4W_ROOT%\\share\\gdal\nset PROJ_LIB=%OSGEO4W_ROOT%\\share\\proj\nset PATH=%PATH%;%PYTHON_ROOT%;%OSGEO4W_ROOT%\\bin\nreg ADD "HKLM\\SYSTEM\\CurrentControlSet\\Control\\Session Manager\\Environment" /v Path /t REG_EXPAND_SZ /f /d "%PATH%"\nreg ADD "HKLM\\SYSTEM\\CurrentControlSet\\Control\\Session Manager\\Environment" /v GDAL_DATA /t REG_EXPAND_SZ /f /d "%GDAL_DATA%"\nreg ADD "HKLM\\SYSTEM\\CurrentControlSet\\Control\\Session Manager\\Environment" /v PROJ_LIB /t REG_EXPAND_SZ /f /d "%PROJ_LIB%"\n
\n\n\n
\n
\n

Install Django and set up databaseLink to this heading#

\n

Finally, install Django on your system.

\n

Footnotes

\n\n
\n
\n
","rootId":"geodjango-installation","toc":[{"title":"Overview","anchor":"overview","children":[]},{"title":"Requirements","anchor":"requirements","children":[{"title":"Python and Django","anchor":"python-and-django","children":[]},{"title":"Spatial database","anchor":"spatial-database","children":[]}]},{"title":"Installation","anchor":"installation","children":[{"title":"Geospatial libraries","anchor":"geospatial-libraries","children":[]},{"title":"Database installation","anchor":"database-installation","children":[]},{"title":"DATABASES configuration","anchor":"databases-configuration","children":[]},{"title":"Add django.contrib.gis to INSTALLED_APPS","anchor":"add-django-contrib-gis-to-installed-apps","children":[]}]},{"title":"Troubleshooting","anchor":"troubleshooting","children":[{"title":"Library environment settings","anchor":"library-environment-settings","children":[{"title":"LD_LIBRARY_PATH environment variable","anchor":"ld-library-path-environment-variable","children":[]},{"title":"Setting system library path","anchor":"setting-system-library-path","children":[]},{"title":"Install binutils","anchor":"install-binutils","children":[]}]}]},{"title":"Platform-specific instructions","anchor":"platform-specific-instructions","children":[{"title":"macOS","anchor":"macos","children":[{"title":"Python","anchor":"python","children":[]},{"title":"Postgres.app","anchor":"postgres-app","children":[]},{"title":"Homebrew","anchor":"homebrew","children":[]},{"title":"KyngChaos packages","anchor":"kyngchaos-packages","children":[{"title":"psycopg2","anchor":"psycopg2","children":[]},{"title":"Fink","anchor":"fink","children":[]}]},{"title":"MacPorts","anchor":"macports","children":[]}]},{"title":"Windows","anchor":"windows","children":[{"title":"Python","anchor":"id20","children":[]},{"title":"PostgreSQL","anchor":"postgresql","children":[]},{"title":"PostGIS","anchor":"postgis","children":[]},{"title":"psycopg2","anchor":"id23","children":[]},{"title":"OSGeo4W","anchor":"osgeo4w","children":[]},{"title":"Modify Windows environment","anchor":"modify-windows-environment","children":[]},{"title":"Install Django and set up database","anchor":"install-django-and-set-up-database","children":[]}]}]}],"breadcrumbs":[{"docname":"ref/index","title":"API Reference","url":"/ko/3.0/ref/"},{"docname":"ref/contrib/index","title":"contrib packages","url":"/ko/3.0/ref/contrib/"},{"docname":"ref/contrib/gis/index","title":"GeoDjango","url":"/ko/3.0/ref/contrib/gis/"}],"prev":{"docname":"ref/contrib/gis/tutorial","title":"GeoDjango Tutorial","url":"/ko/3.0/ref/contrib/gis/tutorial/"},"next":{"docname":"ref/contrib/gis/install/geolibs","title":"Installing Geospatial libraries","url":"/ko/3.0/ref/contrib/gis/install/geolibs/"},"formats":{"html":"/ko/3.0/ref/contrib/gis/install/","markdown":"/ko/3.0/ref/contrib/gis/install.md","json":"/ko/3.0/ref/contrib/gis/install.json"},"source":"https://github.com/django/django/blob/stable/3.0.x/docs/ref/contrib/gis/install/index.txt","official":"https://docs.djangoproject.com/ko/3.0/ref/contrib/gis/install/","inVersions":["6.1","6.0","5.2","5.1","5.0","4.2","4.1","4.0","3.2","3.1","3.0","2.2","2.1","2.0","1.11"],"inLocales":["en","zh-hans","fr","ja","id","pt-br","ko","es","el","pl"]}