jeff/umap
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #1440 from umap-project/almet/rework-docs

Browse source
This commit is contained in:
Alexis Métaireau 2023-12-06 10:40:24 +00:00 committed by GitHub
commit e4ad904536
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
17 changed files with 539 additions and 885 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

77
docs/architecture/frontend.md Normal file
View file

@ -0,0 +1,77 @@
# The frontend
!!! info "These are notes"
Consider this page as notes taken while exploring uMap. It's not covering everything but hopefully will help you get a basic understanding of how things work.
uMap uses Leaflet on the frontend. A lot of uMap objects extends the ones from Leaflet with additional abilities.
```mermaid
erDiagram
Map ||--o{ DataLayer : datalayers
Map{
JSON permissions
JSON metadata
}
DataLayer ||--o{Feature : data
DataLayer {
JSON metadata
JSON permissions
}
```
Here are the important concepts and files:
- `umap.js` contains `Map`, the map object. It's the main entry point, which references all the related properties. It contains metadata, permissions, and data layers.
- `umap.layer.js` contains `DataLayer`, which contains metadata, permissions, and data.
- `umap.permissions.js` handles the permissions of the map. There is a different file handling the permissions of the datalayer:
- `umap.datalayer.permissions.js`.
## Map (`L.U.Map`)
`L.U.Map` is the class that's called by the server templates (in `map_init.html` and `map_fragment.html` used when we display lists of maps, like the homepage).
It contains references to datalayers, and to the controls (the buttons that appears on the map)
To be able to change the way the client behaves, querystring parameters can be used to overload the settings stored in the database. This is useful for instance when using iframes to display the map on a different website.
uMap has an edit mode. If you don't have the rights you cannot save nor edit, you can't edit the permissions as well.
A map contains references to:
- controls
- datalayers
## DataLayers (`L.U.Datalayer`)
The datalayers contains data, and a layer (a way to represent them).
Each data layer contains a "layer", to know what type of layer it is. It's one of:
- Choropleth (`L.U.Layer.Choropleth`)
- Cluster (`L.U.Layer.Cluster`)
- Heat (`L.U.Layer.Heat`)
When the data layers are initialized, they can have two states:
- `loaded`: the object is loaded in memory. At this stage we have access to all the datalayer's metada (name, type, id)
- `dataLoaded` : the data is available to be used, so we can for instance compute the center of the map (when it's dynamic).
- `backupOptions` is here to make it possible to cancel what have been done (using undo). It stores the old settings for the data-layer.
## Storage
To mark what needs to be synced with the server, uMap currently mark objects as "dirty". Something marked as "dirty" has changed on the client, but is not yet saved on the server.
Each map, datalayer and permission objects can be marked as "dirty". When a change is made on an object, it will mark its parent as "dirty" as well, so it can be updated accordingly.
### Saving data to the server with `umap.save()`
Here is what's being done when you call `map.save()`:
1. `map.saveSelf()`, posting `name`, `center` and `settings` to the server, and then
2. calls `permission.save()`, which will post the permissions to the server, and then call back
3. `map.continueSaving()`, which will take the first dirtyLayer and call
4. `datalayer.save()` on it. It does the following:
1. Post the data (`name`, `displayOnLoad`, `rank`, `settings`, and `geojson`)
2. Calls `permission.save()`, posting `edit_status` to the server, and then calling `map.continue_saving()` and remove the datalayer from `dirtyDatalayers`.
5. When the `dirtyDatalayers` list is empty, we are done.

11
docs/architecture/overview.md Normal file
View file

@ -0,0 +1,11 @@
# Overview of uMap
uMap is a server and a client. The server is build with the Django framework, and the client uses (vanilla) JavaScript, on top of Leaflet.
Basically, here is how it works:
- Most of the data is stored as [geoJSON files](https://geojson.org/), on the server.
- Some other parts of the data is stored in the database (users, permissions, etc)
- PostGIS is used for some of its geo features, but for the most part, the computation is done on the frontend with Leaflet.
The server is meant to be a simple layer to do the storage and serve the JavaScript.

4
docs/assets/logo.svg Normal file
View file

@ -0,0 +1,4 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 128 128" width="128" height="128">
<path d="M36.5 6.2A64 64 0 0 0 64 128C14.5 81.8 3.1 24.8 36.5 6.2zM64 128A64 64 0 0 0 91.5 6.2c33.4 18.6 22 75.6-27.5 121.8z" fill="#fff"/>
<path d="M87.7 33.8a23.7 23.7 0 1 1-47.4 0 23.7 23.7 0 0 1 47.4 0z" fill="#fff"/>
</svg>
Side by side

After

Width:  |  Height:  |  Size: 321 B

5
docs/custom.md → docs/config/customize.md
View file

@ -1,7 +1,6 @@
# Customize your uMap installation # Customize your uMap installation
When running your own uMap, you may want to change its appearance, for example
When running your own uMap, you may want to changed its appearance, for example
you want your own logo on the home page, or you want to apply some design, or you want your own logo on the home page, or you want to apply some design, or
you want to add some tracking (but anonymous!) script… you want to add some tracking (but anonymous!) script…
@ -10,7 +9,7 @@ that.
So basically you'll have your own templates and/or statics directories where So basically you'll have your own templates and/or statics directories where
you will put the templates or statics you want to control (and only those). you will put the templates or statics you want to control (and only those).
Inside thore directory, you need to respect the exact relative path of the Inside those directories, you need to respect the exact relative path of the
templates or statics you are adding, relatively to the templates or statics you are adding, relatively to the
[templates](https://github.com/umap-project/umap/tree/master/umap/templates) [templates](https://github.com/umap-project/umap/tree/master/umap/templates)
and and

16
docs/administration.md → docs/config/icons.md
View file

@ -1,10 +1,4 @@
# Administration # Icons
You can access uMap administration page by navigating to `https://your.server.org/admin`
You will have to connect with the admin account created during installation. Default admin username is "umap".
## Icons
Icons (aka pictograms in uMap sources) can be used in your map markers. Icons (aka pictograms in uMap sources) can be used in your map markers.
@ -22,11 +16,11 @@ Example of icons libraries you may want to use:
- [SJJB Icons](http://www.sjjb.co.uk/mapicons/contactsheet) - [SJJB Icons](http://www.sjjb.co.uk/mapicons/contactsheet)
- [Remix](https://remixicon.com/) - [Remix](https://remixicon.com/)
### Import icons manually ## Import icons manually
You can import icons manually by going to your uMap admin page: `https://your.server.org/admin` You can import icons manually by going to your uMap admin page: `https://your.server.org/admin`
### Import icons automatically ## Import icons automatically
To import icons on your uMap server, you will need to use the command `umap import_pictograms`. To import icons on your uMap server, you will need to use the command `umap import_pictograms`.
@ -34,9 +28,11 @@ Note: you can get help with `umap import_pictograms -h`
Basic usage: Basic usage:
```bash
umap import_pictograms --attribution "Maki Icons by Mapbox" path/to/icons/directory/ umap import_pictograms --attribution "Maki Icons by Mapbox" path/to/icons/directory/
```
### Categories ## Categories
uMap can render icons grouped into categories. When using the import script, any uMap can render icons grouped into categories. When using the import script, any
subfolder will be used as category. subfolder will be used as category.

71
docs/settings.md → docs/config/settings.md
View file

@ -5,7 +5,7 @@ are doing.
The Django settings reference is here: https://docs.djangoproject.com/en/4.2/ref/settings/ The Django settings reference is here: https://docs.djangoproject.com/en/4.2/ref/settings/
Here are a few relevent settings for uMap. Here are a few relevant settings for uMap.
## Usage ## Usage
@ -16,6 +16,7 @@ Those settings should either:
`UMAP_SETTINGS` env var `UMAP_SETTINGS` env var
- be declared as env vars directly, for simple ones (string/boolean/list) - be declared as env vars directly, for simple ones (string/boolean/list)
#### ALLOWED_HOSTS #### ALLOWED_HOSTS
The hosts that uMap expects. The hosts that uMap expects.
@ -23,15 +24,46 @@ The hosts that uMap expects.
Can be set through env var too: `ALLOWED_HOSTS=umap.mydomain.org,u.mydomain.org` Can be set through env var too: `ALLOWED_HOSTS=umap.mydomain.org,u.mydomain.org`
#### COMPRESS_ENABLED
#### COMPRESS_STORAGE
To activate the compression of the static files, you can set this flag to `True`.
You can then run the following command to compress the assets:
```bash
umap compress
```
Optionally add `COMPRESS_STORAGE = "compressor.storage.GzipCompressorFileStorage"`
and add `gzip_static on` directive to Nginx `/static` location, so Nginx will
serve pregenerated files instead of compressing them on the fly.
#### DEBUG #### DEBUG
Set it to True for easier debugging in case of error. Set it to `True` for easier debugging in case of error.
#### EMAIL_BACKEND #### EMAIL_BACKEND
Must be configured if you want uMap to send emails to anonymous users. Must be configured if you want uMap to send emails to anonymous users.
See [Emails](install.md#emails) for more details. UMap can send the anonymous edit link by email. For this to work, you need to
add email specific settings. See [Django](https://docs.djangoproject.com/en/4.2/topics/email/#smtp-backend)
documentation.
In general, you'll need to add something like this in your local settings:
```python title="local_settings.py"
FROM_EMAIL = "youradmin@email.org"
EMAIL_BACKEND = "django.core.mail.backends.smtp.EmailBackend"
EMAIL_HOST = "smtp.provider.org"
EMAIL_PORT = 456
EMAIL_HOST_USER = "username"
EMAIL_HOST_PASSWORD = "xxxx"
EMAIL_USE_TLS = True
# or
EMAIL_USE_SSL = True
```
#### ENABLE_ACCOUNT_LOGIN #### ENABLE_ACCOUNT_LOGIN
@ -48,6 +80,7 @@ See `EMAIL_BACKEND`.
Set it to the default language you want. `LANGUAGE_CODE = "it"` Set it to the default language you want. `LANGUAGE_CODE = "it"`
#### Default map center
#### LEAFLET_LONGITUDE, LEAFLET_LATITUDE, LEAFLET_ZOOM #### LEAFLET_LONGITUDE, LEAFLET_LATITUDE, LEAFLET_ZOOM
Default longitude, latitude and zoom for the map Default longitude, latitude and zoom for the map
@ -128,14 +161,14 @@ To be used when you want to override some HTML templates:
UMAP_CUSTOM_TEMPLATES = "/path/to/custom/templates" UMAP_CUSTOM_TEMPLATES = "/path/to/custom/templates"
See [customization](custom.md) for details. See [customization](customize.md) for details.
#### UMAP_CUSTOM_STATICS #### UMAP_CUSTOM_STATICS
To be used when you want to override some CSS or images: To be used when you want to override some CSS or images:
UMAP_CUSTOM_STATICS = "/path/to/custom/static" UMAP_CUSTOM_STATICS = "/path/to/custom/static"
See [customization](custom.md) for details. See [customization](customize.md) for details.
#### UMAP_EXTRA_URLS #### UMAP_EXTRA_URLS
@ -198,7 +231,27 @@ How many maps to show in the user "my maps" page.
Use it if you take control over the search configuration. Use it if you take control over the search configuration.
See [search](install.md#search) for details. UMap uses PostgreSQL tsvector for searching. In case your database is big, you
may want to add an index. For that, here are the SQL commands to run:
```SQL
# Create a basic search configuration
CREATE TEXT SEARCH CONFIGURATION umapdict (COPY=simple);
# If you also want to deal with accents and case, add this before creating the index
CREATE EXTENSION unaccent;
CREATE EXTENSION btree_gin;
ALTER TEXT SEARCH CONFIGURATION umapdict ALTER MAPPING FOR hword, hword_part, word WITH unaccent, simple;
# Now create the index
CREATE INDEX IF NOT EXISTS search_idx ON umap_map USING GIN(to_tsvector('umapdict', COALESCE(name, ''::character varying)::text), share_status);
```
Then set:
```python title="settings.py"
UMAP_SEARCH_CONFIGURATION = "umapdict"
```
#### UMAP_READONLY #### UMAP_READONLY
@ -208,6 +261,12 @@ Is your instance readonly? Useful for server maintenance.
Should uMap gzip datalayers geojson. Should uMap gzip datalayers geojson.
#### UMAP_XSENDFILE_HEADER
Can be set to `X-Accel-Redirect` to enable the [NGINX X-Accel](https://www.nginx.com/resources/wiki/start/topics/examples/xsendfile/) feature.
See the NGINX documentation in addition.
#### SOCIAL_AUTH_OPENSTREETMAP_KEY, SOCIAL_AUTH_OPENSTREETMAP_SECRET #### SOCIAL_AUTH_OPENSTREETMAP_KEY, SOCIAL_AUTH_OPENSTREETMAP_SECRET
If you use OpenStreetMap as OAuth provider, use those settings. If you use OpenStreetMap as OAuth provider, use those settings.

95
docs/contributing.md
View file

@ -1,92 +1,55 @@
# Contributing # Contributing
So you want to contribute to uMap? Great news 🙌
We've put together this document so you have a brief overview of how things work.
You can help on different areas: translation, bug triage, documentation and development.
## Translating ## Translating
Translation is managed through [Transifex](https://www.transifex.com/openstreetmap/umap/). uMap is translated to more than 50 languages! The translation is managed through [Transifex](https://www.transifex.com/openstreetmap/umap/). You will need an account to get started, and then you'll be able to translate easily.
## Bug Triaging ## Bug Triage
You are very welcome to help us triaging [uMap issues](https://github.com/umap-project/umap/issues). You are very welcome to help us triage [uMap issues](https://github.com/umap-project/umap/issues). Don't hesitate to help other users by answering questions, give your point of view in discussions and just report bugs!
* Help other users by answering questions ## Reporting a bug
* Give your point of view in discussions
* And so on...
## Development on Ubuntu If you've encountered a bug, don't hesitate to tell us about it. The best way to do this is by [opening a ticket on the bug tracker](https://github.com/umap-project/umap/issues/new/choose). But please, first, [have a look around](https://github.com/umap-project/umap/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) to see if other users already reported something 😅
### Environment setup ## Hacking on the code
Choose one of the following two config: Following the [installation instructions](install.md) should get you started to hack on the code.
#### Config global to your desktop ### Installing dev dependencies
Follow the procedure [Ubuntu from scratch](ubuntu.md) To be sure to install all the dev dependencies, and have everything working locally.
But instead using folders /etc/umap, you can create a ~/.umap folder. ```bash
This folder will contain the umap.conf file. make develop
And for folder /srv/umap, you can create a ~/umap folder (We will remove this folder later)
You will have to set an env var, we will set it in your .bashrc:
nano ~/.bashrc
Add the following at the end of file:
```
# uMap
export UMAP_SETTINGS=~/.umap/umap.conf
``` ```
Then refresh your terminal ### Hack!
source ~/.bashrc You can now do your changes in a specific branch, and when you're ready you can open a pull-request for us to review.
Run your local uMap and check that it is working properly. ### Run tests
#### Config inside your local git repo Multiple tests suites are in use in the project.
Follow the procedure [Ubuntu from scratch](ubuntu.md) | Test suite | Location | Command |
| ---------- | -------- | ------- |
| Python unit tests | `umap/tests/` | `pytest . --ignore umap/tests/integration` |
| Javascript unit tests | `umap/static/test` | `make testjs`|
| Integration tests | `umap/tests/integration` | `pytest umap/tests/integration` |
You can use the local.py.sample in the git repo and copy it to your local git repo to umap/settings/local.py All the tests are run when you're creating a pull request, to avoid regressions.
See [Installation](install.md) ### Merging rules
### Hacking on the code Pull requests need to be accepted by one maintainer of the project. Please be patient, we try to do our best, but it sometimes takes time.
Create a workspace folder `~/wk` and go into it. ## Update the translations
"git clone" the main repository and go in the `umap/` folder.
Once you are in the `umap/` folder, create a Python virtual environment:
python3 -m venv venv
source venv/bin/activate
Now, the `umap` command will be available.
*Note: if you close your terminal, you will need to re-run that command from `~/wk/umap`:*
source venv/bin/activate
To test your code, you will add to install umap from your git folder. Go to `~/wk/umap` and run:
make install
This command will check dependencies and install uMap from sources inside folder.
When installing from the git repository, do not forget to run `make installjs` and `make vendors`, before running `umap collectstatic` (as mentioned in [Ubuntu from scratch](ubuntu.md)).
Create a PostgreSQL database and apply migrations to setup your database:
createdb umap
umap migrate
You should now be able to start your local uMap instance:
umap runserver 0.0.0.0:8000
### Update translations
Install needed tools: Install needed tools:

38
docs/deploy/docker.md Normal file
View file

@ -0,0 +1,38 @@
# Docker
An official uMap docker image is [available on the docker hub](https://hub.docker.com/r/umap/umap). But, if you prefer to run it with docker compose, here is the configuration file:
```yaml title="docker-compose.yml"
version: '3'
services:
db:
# check https://hub.docker.com/r/postgis/postgis to see available versions
image: postgis/postgis:14-3.4-alpine
environment:
- POSTGRES_HOST_AUTH_METHOD=trust
volumes:
- umap_db:/var/lib/postgresql/data
app:
# Check https://hub.docker.com/r/umap/umap/tags to find the latest version
image: umap/umap:1.3.7
ports:
# modify the external port (8001, on the left) if desired, but make sure it matches SITE_URL, below
- "8001:8000"
environment:
- DATABASE_URL=postgis://postgres@db/postgres
- SITE_URL=https://localhost:8001/
- STATIC_ROOT=/srv/umap/static
- MEDIA_ROOT=/srv/umap/uploads
volumes:
- umap_userdata:/srv/umap/uploads
# FIX the path on the left, below, to your location
- /home/ubuntu/umap.conf:/etc/umap/umap.conf
restart: always
depends_on:
- db
volumes:
umap_userdata:
umap_db:
```

121
docs/deploy/nginx.md Normal file
View file

@ -0,0 +1,121 @@
# Configuring Nginx
Here are some configuration files to use umap with nginx and [uWSGI](https://uwsgi-docs.readthedocs.io/en/latest/), a server for python, which will handle your processes for you.
```nginx title="nginx.conf"
upstream umap {
server unix:///srv/umap/uwsgi.sock;
}
server {
# the port your site will be served on
listen 80;
listen [::]:80;
listen 443 ssl;
listen [::]:443 ssl;
# the domain name it will serve for
server_name your-domain.org;
charset utf-8;
# max upload size
client_max_body_size 5M; # adjust to taste
# Finally, send all non-media requests to the Django server.
location / {
uwsgi_pass umap;
include /srv/umap/uwsgi_params;
}
}
```
## uWSGI
```nginx title="uwsgi_params"
uwsgi_param QUERY_STRING $query_string;
uwsgi_param REQUEST_METHOD $request_method;
uwsgi_param CONTENT_TYPE $content_type;
uwsgi_param CONTENT_LENGTH $content_length;
uwsgi_param REQUEST_URI $request_uri;
uwsgi_param PATH_INFO $document_uri;
uwsgi_param DOCUMENT_ROOT $document_root;
uwsgi_param SERVER_PROTOCOL $server_protocol;
uwsgi_param REQUEST_SCHEME $scheme;
uwsgi_param HTTPS $https if_not_empty;
uwsgi_param REMOTE_ADDR $remote_addr;
uwsgi_param REMOTE_PORT $remote_port;
uwsgi_param SERVER_PORT $server_port;
uwsgi_param SERVER_NAME $server_name;
```
```ini title="uwsgi.ini"
[uwsgi]
uid = umap
gid = users
# Python related settings
# the base directory (full path)
chdir = /srv/umap/
# umap's wsgi module
module = umap.wsgi
# the virtualenv (full path)
home = /srv/umap/venv
# process-related settings
# master
master = true
# maximum number of worker processes
processes = 4
# the socket (use the full path to be safe)
socket = /srv/umap/uwsgi.sock
# ... with appropriate permissions - may be needed
chmod-socket = 666
stats = /srv/umap/stats.sock
# clear environment on exit
vacuum = true
plugins = python3
```
## Static files
```nginx title="nginx.conf"
location /static {
autoindex off;
access_log off;
log_not_found off;
sendfile on;
gzip on;
gzip_vary on;
alias /path/to/umap/var/static/;
}
location /uploads {
autoindex off;
sendfile on;
gzip on;
gzip_vary on;
alias /path/to/umap/var/data/;
# Exclude direct acces to geojson, as permissions must be
# checked py django.
location /uploads/datalayer/ { return 404; }
}
```
## X-Accel-Redirect
With this configuration, NGINX will directly serve the geoJSON layers, but uMap will check the permissions.
```title="umap.conf"
UMAP_XSENDFILE_HEADER = 'X-Accel-Redirect'
```
```title="nginx.conf"
location /internal/ {
internal;
gzip_vary on;
gzip_static on;
alias /path/to/umap/var/data/;
}
```

133
docs/docker.md
View file

@ -1,133 +0,0 @@
# Docker
There is now an official [uMap](https://hub.docker.com/r/umap/umap) image.
To run it with docker compose, create a `docker-compose.yml` like this:
_Sample docker-compose.yml_
```yaml
version: '3'
services:
db:
# check https://hub.docker.com/r/postgis/postgis to see available versions
image: postgis/postgis:14-3.4-alpine
environment:
- POSTGRES_HOST_AUTH_METHOD=trust
volumes:
- umap_db:/var/lib/postgresql/data
app:
# Check https://hub.docker.com/r/umap/umap/tags to find the latest version
image: umap/umap:1.3.7
ports:
# modify the external port (8001, on the left) if desired, but make sure it matches SITE_URL, below
- "8001:8000"
environment:
- DATABASE_URL=postgis://postgres@db/postgres
- SITE_URL=https://localhost:8001/
- STATIC_ROOT=/srv/umap/static
- MEDIA_ROOT=/srv/umap/uploads
volumes:
- umap_userdata:/srv/umap/uploads
# FIX the path on the left, below, to your location
- /home/ubuntu/umap.conf:/etc/umap/umap.conf
restart: always
depends_on:
- db
volumes:
umap_userdata:
umap_db:
```
Next, create a basic settings file, named `umap.conf` in the same directory.
You can use this example below and it will run, but you may want to look at the project sample config, using `wget https://raw.githubusercontent.com/umap-project/umap/master/umap/settings/local.py.sample -O /etc/umap/umap.conf` and modify as needed.
Make sure the settings in the docker-compose don't conflict with the sample config and vice-versa. In particular, remove the DATABASES section from the config file if using the docker-compose file, or it will override the DATABASE_URL setting and things won't work.
_Sample umap.conf_
```python
"""
Example settings for docker quickstart:
Lots of stuff has been removed for simplicity
See https://umap-project.readthedocs.io/en/master/settings/
Things YOU need to change before launching:
- modify SECRET_KEY
"""
from umap.settings.base import * # pylint: disable=W0614,W0401
SECRET_KEY = '!!secretsecret!!'
INTERNAL_IPS = ('127.0.0.1', )
ALLOWED_HOSTS = ['*', ]
DEBUG = True
COMPRESS_ENABLED = True
COMPRESS_OFFLINE = True
LANGUAGE_CODE = 'en'
# Set to False if login into django account should not be possible. You can
# administer accounts in the admin interface.
ENABLE_ACCOUNT_LOGIN = True
AUTHENTICATION_BACKENDS = (
'django.contrib.auth.backends.ModelBackend',
)
# Enables a banner letting users know this site is not for production use
UMAP_DEMO_SITE = True
# Whether to allow non authenticated people to create maps.
UMAP_ALLOW_ANONYMOUS = True
```
Some basic settings are available through env vars (see https://github.com/umap-project/umap/blob/master/umap/settings/base.py) and can be defined right in the docker-compose file,
but if you need more custom ones (like custom OAuth configuration), the easiest
way is to put them in a [settings file](settings.md) and mount it to `/etc/umap/umap.conf`.
---
#### Quick sidebar about docker and docker-compose
A multi-platform tutorial on [installing docker](https://docs.docker.com/get-docker/) and docker-compose is outside the scope of this howto, but if you are on a recent Ubuntu, this is all you need to install both:
```bash
sudo groupadd docker
sudo snap install docker
sudo usermod -aG docker $USER
# EXIT and log back in to pickup the docker group membership, then test with
docker run hello-world
```
Current versions of docker compose are integrated into the docker command and launch with `docker compose` (two words) -- older versions use a separate binary named `docker-compose`. Either one will work for this.
---
### Initial launch
Start the server with
```bash
docker compose up
```
... and let it run some initial setup until the output quiesces with a message about spawning uWSGI workers. Because there is a race between the time the app tries to connect to the DB and when the DB is actually ready, you might see a few exceptions/errors about 'psycopg' being unable to connect. This should sort itself out as the app retries.
### Create superuser
Now you need to create your site superuser. Stop the server (Ctrl-C) and then type:
```bash
docker-compose run app /venv/bin/umap createsuperuser
```
Once that's done, you can relaunch your server with `docker compose up`
### Try It!
You should now be able to browse to your uMap instance from a browser on your local system, by pointing your browser to `https://localhost:8001/` (equivalent to `${SITE_URL}` in the docker-compose file, above).
### Administration
To administer the site (add users, change map tiles, other customizations) log in as the root user you just created, then go to `${SITE_URL}/admin`.

13
docs/index.md
View file

@ -1,8 +1,13 @@
# uMap developer documentation # uMap developer documentation
*This documentation is intended for people aiming to install and configure uMap. !!! info "Developer docs"
If you are looking for user documentation, have a look at [the OSM wiki page](http://wiki.openstreetmap.org/wiki/UMap#Tutorials).*
uMap is a Django project, so in case of doubt always refer to the [Django documentation](https://docs.djangoproject.com). This documentation is intended for developers or system administrators.
Now let's start by [installing uMap](install.md)! If you are looking for user documentation, have a look at [the OSM wiki page](http://wiki.openstreetmap.org/wiki/UMap#Tutorials).
uMap lets you create maps with OpenStreetMap layers in a minute, and embed them in your site.
- 🤗 Get started and [follow the installation guide](install.md).
- 🤩 Want to contribute? [Read the contributing guidelines](contributing.md).
- 🤔 Curious about umap internals? [Check the architecture overview](architecture/overview.md).

148
docs/install.md
View file

@ -1,43 +1,96 @@
# Installation # Installation
*Note: for Ubuntu, follow procedure [Ubuntu from scratch](ubuntu.md)* ## System dependencies
*Note: for Windows, follow procedure [Installing on Windows](install_windows.md)* uMap is built with the [Python](https://python.org) language, and the [Django](https://djangoproject.com) framework. It needs a [PostgreSQL](https://www.postgresql.org/) database, with the [Postgis](https://postgis.net/) extension enabled.
Create a geo aware database. See [Geodjango doc](https://docs.djangoproject.com/en/dev/ref/contrib/gis/install/) for backend installation. Here are the commands to install the required system dependencies.
Create a virtual environment === "Debian"
```bash
sudo apt update
sudo apt install python3 python3-dev python3-venv virtualenv postgresql gcc postgis libpq-dev
```
=== "Arch Linux"
```bash
yay postgis extra/postgresql-libs
```
=== "OS X (with brew)"
```bash
brew install postgis
```
=== "Fedora"
```bash
sudo dnf install postgis libpq-devel make gcc python3-devel
```
### PostgreSQL
Depending on your system, you might need to create a postgres user, the database, and initialize postgres. Here's how:
```bash
createuser umap -U postgres
createdb umap -O umap -U postgres
psql umap -c "CREATE EXTENSION postgis" -Upostgres
```
## Getting started
Create a geo aware database. See the [GeoDjango docs](https://docs.djangoproject.com/en/dev/ref/contrib/gis/install/) for backend installation.
### Creating a virtual environment
It is recommended to install python projects in a virtual environment to avoid mixing the project installation with your system dependencies. But it's not a requirement and it is up to you 🫣
```bash
python -m venv venv python -m venv venv
source venv/bin/activate source venv/bin/activate
```
Install dependencies and project ### Installing the dependencies
You can get all the project dependencies installed with the following command:
```bash
pip install umap-project pip install umap-project
```
Create a default `local_settings` file ### Configuration
Create a default `local_settings.py` file, that you will modify with your setting.
```bash
wget https://raw.githubusercontent.com/umap-project/umap/master/umap/settings/local.py.sample -O local_settings.py wget https://raw.githubusercontent.com/umap-project/umap/master/umap/settings/local.py.sample -O local_settings.py
```
Reference it as env var: Reference it as env var:
```bash
export UMAP_SETTINGS=`pwd`/local_settings.py export UMAP_SETTINGS=`pwd`/local_settings.py
```
Add database connection information in `local_settings.py`, for example Add database connection information in `local_settings.py`, for example
```python title="local_settings.py"
DATABASES = { DATABASES = {
'default': { 'default': {
'ENGINE': 'django.contrib.gis.db.backends.postgis', 'ENGINE': 'django.contrib.gis.db.backends.postgis',
'NAME': 'umap', 'NAME': 'umap',
} }
} }
```
Depending on your installation, you might need to change the USER that connects the database. Depending on your installation, you might need to change the user that connects the database.
It should look like this: It should look like this:
```python title="local_settings.py"
DATABASES = { DATABASES = {
"default": { "default": {
"ENGINE": "django.contrib.gis.db.backends.postgis", "ENGINE": "django.contrib.gis.db.backends.postgis",
@ -45,19 +98,23 @@ It should look like this:
"USER": "postgres", "USER": "postgres",
} }
} }
```
Add a `SECRET_KEY` in `local_settings.py` with a long random secret key Add a `SECRET_KEY` in `local_settings.py` with a long random secret key
```title="local_settings.py"
SECRET_KEY = "a long and random secret key that must not be shared" SECRET_KEY = "a long and random secret key that must not be shared"
```
You can easily generate one with openssl: You can easily generate one with [openssl](https://www.openssl.org/):
```bash
openssl rand -base64 32 openssl rand -base64 32
```
uMap uses [python-social-auth](http://python-social-auth.readthedocs.org/) for user authentication. So you will need to configure it according to your uMap uses [python-social-auth](http://python-social-auth.readthedocs.org/) for user authentication. So you will need to configure it according to your needs. For example
needs. For example
```title="local_settings.py"
AUTHENTICATION_BACKENDS = ( AUTHENTICATION_BACKENDS = (
'social_auth.backends.contrib.github.GithubBackend', 'social_auth.backends.contrib.github.GithubBackend',
'social_auth.backends.contrib.bitbucket.BitbucketBackend', 'social_auth.backends.contrib.bitbucket.BitbucketBackend',
@ -70,6 +127,7 @@ needs. For example
BITBUCKET_CONSUMER_SECRET = 'zzz' BITBUCKET_CONSUMER_SECRET = 'zzz'
TWITTER_CONSUMER_KEY = "xxx" TWITTER_CONSUMER_KEY = "xxx"
TWITTER_CONSUMER_SECRET = "yyy" TWITTER_CONSUMER_SECRET = "yyy"
```
Example of callback URL to use for setting up OAuth apps Example of callback URL to use for setting up OAuth apps
@ -77,75 +135,37 @@ Example of callback URL to use for setting up OAuth apps
Adapt the `STATIC_ROOT` and `MEDIA_ROOT` to your local environment. Adapt the `STATIC_ROOT` and `MEDIA_ROOT` to your local environment.
Create the tables ## Bootstrapping the database
Here are the commands you'll need to run to create the tables, collect the static files, etc.
```bash
# Create the database tables
umap migrate umap migrate
Collect and compress the statics # Collect and compress static files
umap collectstatic umap collectstatic
umap compress umap compress
Create a superuser # Create a super user
umap createsuperuser umap createsuperuser
Start the server # Finally start the server
umap runserver 0.0.0.0:8000 umap runserver 0.0.0.0:8000
```
## Search ## Configuring emails
UMap uses PostgreSQL tsvector for searching. In case your database is big, you
may want to add an index. For that, you should do so:
# Create a basic search configuration
CREATE TEXT SEARCH CONFIGURATION umapdict (COPY=simple);
# If you also want to deal with accents and case, add this before creating the index
CREATE EXTENSION unaccent;
CREATE EXTENSION btree_gin;
ALTER TEXT SEARCH CONFIGURATION umapdict ALTER MAPPING FOR hword, hword_part, word WITH unaccent, simple;
# Now create the index
CREATE INDEX IF NOT EXISTS search_idx ON umap_map USING GIN(to_tsvector('umapdict', COALESCE(name, ''::character varying)::text), share_status);
And change `UMAP_SEARCH_CONFIGURATION = "umapdict"` in your settings.
## Emails
UMap can send the anonymous edit link by email. For this to work, you need to UMap can send the anonymous edit link by email. For this to work, you need to
add email specific settings. See [Django](https://docs.djangoproject.com/en/4.2/topics/email/#smtp-backend) add email specific settings. See [the related settings](config/settings.md#email_backend) for more info.
documentation.
In general, you'll need to add something like this in your local settings: ## Upgrading your installation
```
FROM_EMAIL = "youradmin@email.org"
EMAIL_BACKEND = "django.core.mail.backends.smtp.EmailBackend"
EMAIL_HOST = "smtp.provider.org"
EMAIL_PORT = 456
EMAIL_HOST_USER = "username"
EMAIL_HOST_PASSWORD = "xxxx"
EMAIL_USE_TLS = True
# or
EMAIL_USE_SSL = True
```
## Upgrading
Usually, for upgrading, you need those steps: Usually, for upgrading, you need those steps:
``` ```bash
pip install umap-project --upgrade pip install umap-project --upgrade
umap migrate umap migrate
umap collectstatic umap collectstatic
umap compress umap compress
``` ```
Then you need to restart your python server, for example:
```
sudo systemctl restart uwsgi # or gunicorn, or…
```

144
docs/install_windows.md
View file

@ -1,144 +0,0 @@
# Installing uMap on Windows
The **good news** is that it is possible to run uMap server on Windows. However, it is recommended using uMap on a
Linux distribution as it will be easier to install, modify, and deploy. While the following steps have been tested on
Windows 7, they may work for other versions of Windows.
## 1. Prepare the Database
This assumes you've installed PostgreSQL.
- Create a database called "umap"
- Install PostGIS extension in it
##2. Create a directory and a Python virtual environment
This assumes you've installed Python (version 3.8+ 64-bit is a good choice) and virtualenv.
Open a Windows command window, and cd to a directory of your choice. You need to create a sub-directory but the name is
up to you (it doesn't need to be called "production"):
```
mkdir production
cd production
virtualenv venv
venv\Scripts\activate.bat
```
##3. Install GDAL for Python
It is really difficult to install GDAL the "standard" way since it requires compiling GDAL. Instead download an already
compiled pip-compatible wheel package file from
[Unofficial Windows Binaries for Python Extension Packages](https://www.lfd.uci.edu/~gohlke/pythonlibs/#gdal). Note
that cp38 refers to the Python version you are using, so make sure you select the one that matches your Python version
for download.
In the command window, install the downloaded wheel package:
`pip install GDAL-3.0.4-cp38-cp38-win_amd64.whl`
You can test the install from the Python command line. From the Windows command window invoke Python:
```
python
```
then enter some Python commands:
```python
>>> import gdal
>>> print(int(gdal.VersionInfo('VERSION_NUM')))
>>> exit()
```
##4. Install uMap
In the Windows command window:
```
mkdir static
mkdir data
pip install umap-project
```
***Windows Work-Around 1***
Setting the UMAP_SETTINGS environment variable doesn't seem to work on Windows, so put the file in umap's fall-back
location of \etc\umap\umap.conf :
```
mkdir \etc\umap
wget https://raw.githubusercontent.com/umap-project/umap/master/umap/settings/local.py.sample -O \etc\umap\umap.conf
```
Edit the umap.conf file:
***Windows Work-Around 2***
It might be possible to modify django's libgdal.py (umap installed django as one of its dependencies) to detect the
installed GDAL, but until then you can explicitly state the required paths.
Add the GDAL paths somewhere near the top of the umap.conf file (make sure the last part, "gdal300", is the name of the
GDAL DLL in its package dir):
```python
GDAL_LIBRARY_PATH = r'C:\temp\production\venv\Lib\site-packages\osgeo\gdal300'
GEOS_LIBRARY_PATH = r'C:\temp\production\venv\Lib\site-packages\osgeo\geos_c'
PROJ_LIB = r'C:\temp\production\venv\Lib\site-packages\osgeo\data\proj'
```
And while you're editing umap.conf, add the needed parameters to the DATABASES default object :
```python
DATABASES = {
'default': {
'ENGINE': 'django.contrib.gis.db.backends.postgis',
'NAME': 'umap',
'USER': 'postgres',
'PASSWORD': 'postgres',
'HOST': 'localhost',
'PORT': '5432'
}
}
```
And set umap's paths to where you've created the directories:
```python
STATIC_ROOT = '/temp/production/static'
MEDIA_ROOT = '/temp/production/data'
```
Now that the minimal configuration is done, you can do the django-ish portion of the umap install. In the Windows
command window:
```
umap migrate
umap collectstatic
umap createsuperuser
```
***Windows Work-Around 3***
Strangely, having the installed `umap.exe` is not enough. Some script tries to execute "umap" without the ".exe"
extension, so here's a hack to make that work:
```
copy venv\scripts\umap.exe venv\scripts\umap
```
##5. Run umap server
In the Windows command window:
```
umap runserver 127.0.0.1:8000
```
You should now be able to open a browser and go to http://127.0.0.1:8000
If you add some features to a new map and try to save them, you will likely see an error in the Windows command window
running the umap server. This error is a Python error related to doing
`os.remove(name)` on Windows:
```
File "c:\temp\test\venv\lib\site-packages\django\core\files\storage.py", line 303, in delete
os.remove(name)
PermissionError: [WinError 32] The process cannot access the file because it is being used by another process:
'C:\\temp\\production\\data\\datalayer\\1\\1\\layer-1.geojson'
```
***Windows Work-Around 4***
Edit `test\venv\lib\site-packages\django\core\files\storage.py`, and comment out lines 302 and 303:
```python
# else:
# os.remove(name)
```
Now adding features and saving should work. _Now here's the weird part._ Edit `storage.py` to restore it to it's
original state by removing the comment characters you put in. Save the changes, do some more feature editing and
saving in your browser. It still works! This may be due to file/directory locking by Windows.
##6. Installing for development
The previous sections describe the install procedure for running the released version of uMap "as-is". If you want to
modify uMap (and possibly contribute your changes back to the uMap team), have a look at [Contributing](contributing.md)

6
docs/stylesheets/extra.css Normal file
View file

@ -0,0 +1,6 @@
:root {
--md-primary-fg-color: #323e56;
}
.md-typeset a {
color: #7990be !important;
}

406
docs/ubuntu.md
View file

@ -1,406 +0,0 @@
# Tutorial
This tutorial will cover an installation from scratch of a uMap instance in an Ubuntu server.
You need sudo grants on this server, and it must be connected to Internet.
## Install system dependencies
sudo apt update
sudo apt install python3 python3-dev python3-venv virtualenv wget nginx uwsgi uwsgi-plugin-python3 postgresql gcc postgis libpq-dev
*Note: nginx and uwsgi are not required for local development environment*
## Create deployment directories:
sudo mkdir -p /etc/umap
*You can change this path, but then remember to adapt the other steps accordingly.*
## Create a Unix user
sudo useradd -N umap -m -d /srv/umap/
*Here we use the name `umap`, but this name is up to you. Remember to change it
on the various commands and configuration files if you go with your own.*
## Give umap user access to the config folder
sudo chown umap:users /etc/umap
sudo chown umap:users /srv/umap
## Create a postgresql user
sudo -u postgres -D ~postgres createuser umap
## Create a postgresql database
sudo -u postgres -D ~postgres createdb umap -O umap
## Activate PostGIS extension
sudo -u postgres -D ~postgres psql umap -c "CREATE EXTENSION postgis"
## Login as umap Unix user
sudo -u umap -i
From now on, unless we say differently, the commands are run as `umap` user.
## Create a virtualenv and activate it
virtualenv /srv/umap/venv --python=/usr/bin/python3.10
. /srv/umap/venv/bin/activate
*Note: this activation is not persistent, so if you open a new terminal window,
you will need to run again this last line.*
## Install umap
pip install umap-project
## Create a local configuration file
wget https://raw.githubusercontent.com/umap-project/umap/master/umap/settings/local.py.sample -O /etc/umap/umap.conf
## Customize umap.conf
nano /etc/umap/umap.conf
* update the [SECRET_KEY](settings.md#secret_key)
* update the ADMINS list
## Create the tables
umap migrate
## Collect the statics
umap collectstatic
## Create a superuser
umap createsuperuser
## Start the demo server
umap runserver 0.0.0.0:8000
You can now go to [http://localhost:8000/](http://localhost:8000/) and try to create a map for testing.
When you're done with testing, quit the demo server (type Ctrl+C).
## Configure the HTTP API
Now let's configure a proper HTTP server.
### uWSGI
Create a file named `/srv/umap/uwsgi_params`, with this content
(without making any change on it):
```
uwsgi_param QUERY_STRING $query_string;
uwsgi_param REQUEST_METHOD $request_method;
uwsgi_param CONTENT_TYPE $content_type;
uwsgi_param CONTENT_LENGTH $content_length;
uwsgi_param REQUEST_URI $request_uri;
uwsgi_param PATH_INFO $document_uri;
uwsgi_param DOCUMENT_ROOT $document_root;
uwsgi_param SERVER_PROTOCOL $server_protocol;
uwsgi_param REQUEST_SCHEME $scheme;
uwsgi_param HTTPS $https if_not_empty;
uwsgi_param REMOTE_ADDR $remote_addr;
uwsgi_param REMOTE_PORT $remote_port;
uwsgi_param SERVER_PORT $server_port;
uwsgi_param SERVER_NAME $server_name;
```
Then create a configuration file for uWSGI:
nano /srv/umap/uwsgi.ini
And paste this content. Double check paths and user name in case you
have customized some of them during this tutorial. If you followed all the bits of the
tutorial without making any change, you can use it as is:
```
[uwsgi]
uid = umap
gid = users
# Python related settings
# the base directory (full path)
chdir = /srv/umap/
# umap's wsgi module
module = umap.wsgi
# the virtualenv (full path)
home = /srv/umap/venv
# process-related settings
# master
master = true
# maximum number of worker processes
processes = 4
# the socket (use the full path to be safe
socket = /srv/umap/uwsgi.sock
# ... with appropriate permissions - may be needed
chmod-socket = 666
stats = /srv/umap/stats.sock
# clear environment on exit
vacuum = true
plugins = python3
```
### Nginx
Create a new file:
nano /srv/umap/nginx.conf
with this content:
```
# the upstream component nginx needs to connect to
upstream umap {
server unix:///srv/umap/uwsgi.sock;
}
# configuration of the server
server {
# the port your site will be served on
listen 80;
listen [::]:80;
listen 443 ssl;
listen [::]:443 ssl;
# the domain name it will serve for
server_name your-domain.org;
charset utf-8;
# max upload size
client_max_body_size 5M; # adjust to taste
# Finally, send all non-media requests to the Django server.
location / {
uwsgi_pass umap;
include /srv/umap/uwsgi_params;
}
}
```
Remember to adapt the domain name.
### Activate and restart the services
Now quit the `umap` session, simply by typing Ctrl+D.
You should now be logged in as your normal user, which is sudoer.
- Activate the Nginx configuration file:
sudo ln -s /srv/umap/nginx.conf /etc/nginx/sites-enabled/umap
- Activate the uWSGI configuration file:
sudo ln -s /srv/umap/uwsgi.ini /etc/uwsgi/apps-enabled/umap.ini
- Restart both services:
sudo systemctl restart uwsgi nginx
Now you should access your server through your url and create maps:
http://yourdomain.org/
Congratulations!
- - -
## Troubleshooting
- Nginx logs are in /var/log/nginx/:
sudo tail -f /var/log/nginx/error.log
sudo tail -f /var/log/nginx/access.log
- uWSGI logs are in /var/log/uwsgi:
sudo tail -f /var/log/uwsgi/umap.log
## Before going live
### Add a real SECRET_KEY
In your local.py file, add a real secret and unique `SECRET_KEY`, and do
not share it.
### Remove DEMO flag
In your local.py:
UMAP_DEMO_SITE = False
DEBUG = False
### Configure Nginx to serve statics and uploaded files:
In your nginx config:
location /static {
autoindex off;
access_log off;
log_not_found off;
sendfile on;
gzip on;
gzip_vary on;
alias /path/to/umap/var/static/;
}
location /uploads {
autoindex off;
sendfile on;
gzip on;
gzip_vary on;
alias /path/to/umap/var/data/;
# Exclude direct acces to geojson, as permissions must be
# checked py django.
location /uploads/datalayer/ { return 404; }
}
### Configure social auth
Now you can login with your superuser, but you may allow users to user social
authentication.
### Configure default map center
In your local.py change those settings:
LEAFLET_LONGITUDE = 2
LEAFLET_LATITUDE = 51
LEAFLET_ZOOM = 6
### Activate statics compression
In your local.py, set `COMPRESS_ENABLED = True`, and then run the following command
umap compress
Optionally add `COMPRESS_STORAGE = "compressor.storage.GzipCompressorFileStorage"`
and add `gzip_static on` directive to Nginx `/static` location, so Nginx will
serve pregenerated files instead of compressing them on the fly.
### Configure the site URL and short URL
In your local.py:
SITE_URL = "http://localhost:8019"
SHORT_SITE_URL = "http://s.hort"
Also adapt `ALLOWED_HOSTS` accordingly.
### Configure X-Accel-Redirect
In order to let Nginx serve the layer geojsons but uMap still check the permissions,
you can add this settings:
UMAP_XSENDFILE_HEADER = 'X-Accel-Redirect'
And then add this new location in your nginx config (before the `/` location):
location /internal/ {
internal;
gzip_vary on;
gzip_static on;
alias /path/to/umap/var/data/;
}
### Configure ajax proxy cache
uMap allows to use remote URL as data sources, but those URLs are not always
CORS open, so this is why there is this "ajax-proxy" feature, where the URL is
passed to the backend.
Additionally, there is a caching feature, which duration is configurable through
frontend settings. Valid values are: disabled, 5 min, 1 hour, 1 day.
This configuration provides a mix option, where python deals with validating the
URL and parsing the TTL parameter, and then it passes the hand to nginx which
will serve the remote content.
So, roughly:
- the client calls `/ajax-proxy/?url=xxx&ttl=300`
- python will validate the URL (not internal calls…)
- if `UMAP_XSENDFILE_HEADER` is set, then the python returns an empty response
with the path `/proxy/http://url` plus it will set the cache TTL through the
header `X-Accel-Expires`
- this `/proxy/` location is then handled by nginx
In Nginx:
- add the proxy cache
proxy_cache_path /tmp/nginx_ajax_proxy_cache levels=1:2 keys_zone=ajax_proxy:10m inactive=60m;
proxy_cache_key "$uri$is_args$args";
- add those locations (before the `/` location):
location ~ ^/proxy/(.*) {
internal;
add_header X-Proxy-Cache $upstream_cache_status always;
proxy_cache ajax_proxy;
proxy_cache_valid 1m; # Default. Umap will override using X-Accel-Expires
set $target_url $1;
# URL is encoded, so we need a few hack to clean it back.
if ( $target_url ~ (.+)%3A%2F%2F(.+) ){ # fix :// between scheme and destination
set $target_url $1://$2;
}
if ( $target_url ~ (.+?)%3A(.*) ){ # fix : between destination and port
set $target_url $1:$2;
}
if ( $target_url ~ (.+?)%2F(.*) ){ # fix / after port, the rest will be decoded by proxy_pass
set $target_url $1/$2;
}
resolver 8.8.8.8;
add_header X-Proxy-Target $target_url; # For debugging
proxy_pass_request_headers off;
proxy_set_header Content-Type $http_content_type;
proxy_set_header Content-Encoding $http_content_encoding;
proxy_set_header Content-Length $http_content_length;
proxy_read_timeout 10s;
proxy_connect_timeout 5s;
proxy_pass $target_url;
proxy_intercept_errors on;
error_page 301 302 307 = @handle_proxy_redirect;
}
location @handle_proxy_redirect {
resolver 8.8.8.8;
set $saved_redirect_location '$upstream_http_location';
proxy_pass $saved_redirect_location;
}
## Add more tilelayers, pictograms…
Go to the admin: [http://localhost:8020/admin/](http://localhost:8020/admin/),
and create the objects you want.

59
mkdocs.yml
View file

@ -1,15 +1,52 @@
site_name: uMap site_name: uMap docs
site_description: uMap lets you create maps with OpenStreetMap layers in a minute and embed them in your site
repo_name: umap-project/umap
repo_url: https://github.com/umap-project/umap
nav: nav:
- Home: index.md - How-tos:
- Installation: install.md - Getting started: install.md
- Configuration: settings.md - Contribute: contributing.md
- Administration: administration.md - Architecture:
- Contributing: contributing.md - Overview: architecture/overview.md
- how-tos: - Frontend: architecture/frontend.md
- Ubuntu from scratch: ubuntu.md - Configuration:
- Customize your uMap style: custom.md - Settings: config/settings.md
- Install with Docker: docker.md - Customize: config/customize.md
- Icon packs: config/icons.md
- Deployment:
- Docker: deploy/docker.md
- Nginx: deploy/nginx.md
- Changelog: changelog.md - Changelog: changelog.md
theme: readthedocs theme:
name: material
logo: assets/logo.svg
homepage: https://umap-project.org
palette:
- scheme: 'default'
media: '(prefers-color-scheme: light)'
primary: 'custom'
toggle:
icon: 'material/lightbulb'
name: 'Switch to dark mode'
- scheme: 'slate'
media: '(prefers-color-scheme: dark)'
primary: 'custom'
toggle:
icon: 'material/lightbulb-outline'
name: 'Switch to light mode'
features:
- navigation.sections
- navigation.footer
extra_css:
- stylesheets/extra.css
markdown_extensions: markdown_extensions:
- pymdownx.magiclink - pymdownx.magiclink
- admonition
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
combine_header_slug: true

3
pyproject.toml
View file

@ -47,7 +47,8 @@ dev = [
"hatch==1.7.0", "hatch==1.7.0",
"ruff==0.1.6", "ruff==0.1.6",
"djlint==1.31.0", "djlint==1.31.0",
"mkdocs==1.5.2", "mkdocs==1.5.3",
"mkdocs-material>=9.4.14,<10",
"vermin==1.5.2", "vermin==1.5.2",
"pymdown-extensions==10.4", "pymdown-extensions==10.4",
"isort==5.12", "isort==5.12",