Commit graph

229 commits

Author SHA1 Message Date
David Larlet
3d2a1d96fd
Changelog 2023-09-22 14:58:33 -04:00
David Larlet
f11ef754c4
changelog 2023-09-22 12:33:19 -04:00
Yohan Boniface
0988f2e2ee
Merge pull request #1320 from jvmatl/docker_quickstart_docs
A more newbie-friendly Docker HOWTO
2023-09-20 18:36:05 +02:00
John Martinez
7e2b20d085
Update docs/docker.md
Co-authored-by: Yohan Boniface <yohanboniface@free.fr>
2023-09-20 12:07:58 -04:00
Yohan Boniface
d48b272837
Merge pull request #1323 from umap-project/better-document-secret-key
Better documentation for the SECRET_KEY setting
2023-09-20 08:04:00 +02:00
David Larlet
408fcb7c0f
Revert "Add link to django docs for SECRET_KEY"
This reverts commit e2eb510854.
2023-09-19 14:59:31 -04:00
John Martinez
7134269218
Update docs/ubuntu.md
Co-authored-by: David Larlet <3556+davidbgk@users.noreply.github.com>
2023-09-19 14:58:21 -04:00
David Larlet
84c00fa5ba
Better documentation for the SECRET_KEY setting
See https://github.com/umap-project/umap/pull/1322#issuecomment-1726300269
2023-09-19 14:52:57 -04:00
John Martinez
e2eb510854 Add link to django docs for SECRET_KEY 2023-09-19 18:49:21 +00:00
John Martinez
93cfe80370
Update docs/docker.md
typo

Co-authored-by: David Larlet <3556+davidbgk@users.noreply.github.com>
2023-09-19 14:44:31 -04:00
John Martinez
74fd3f4a66
Update docs/docker.md
Typo

Co-authored-by: David Larlet <3556+davidbgk@users.noreply.github.com>
2023-09-19 14:43:51 -04:00
John Martinez
2f21d7b821
Update docs/docker.md
punctuation

Co-authored-by: David Larlet <3556+davidbgk@users.noreply.github.com>
2023-09-19 14:41:14 -04:00
John Martinez
89cfa7d93d Ran through the 'Ubuntu from Scratch' procedure using a fresh Ubuntu 22.04.3 LTS VM and took notes on what worked and what didn't.
Here's a summary of the changes and why

* added 'apt update' before the install -- only _needed_ on a completely fresh VM, but never hurts

* added an install of the virtualenv package, because it is used later but: do you still need it AND python3-venv? I'm assuming it was done that way for a reason.

* changed indentation on the mkdir so it will format correctly

* added `-D ~postgres` to the commands executed as postgres user because the postgres user does not, by default, have permission to read into real user's home directories (at least in 22.04) and so the commands would error out

* change `source <activate>` to `. activate` because the line `sudo -u umap -i` launches `sh`, not `bash`, and `sh` does not recognize the source command. `.` works in either.

* remove the instructions to change STATIC_ROOT and MEDIA_ROOT because they are already defaulted to those values in the current version sample of local.py

* added a notice to change the SECREY_KEY and ADMINS list just because it seemed like a good idea.

Side note: I have not seen any docs anywhere that explains exactly what the secret Key does, or where it is used. It's used a magic variable in the config file.. ?

I am not currently messing with nginx or wsgi, so I can't comment on those parts.
2023-09-19 18:32:13 +00:00
John Martinez
cc9004fbc2 Code review feedback 2023-09-19 17:43:13 +00:00
John Martinez
43a35ee5fd A more newbie-friendly Docker HOWTO 2023-09-19 17:24:32 +00:00
Yohan Boniface
0fa834155d changelog 2023-09-18 11:27:17 +02:00
Yohan Boniface
d8b63974f9 changelog 2023-09-01 17:37:26 +02:00
Yohan Boniface
597b3bb10f Change proxy_cache_key value in documentation
Now that the case is done in the internal redirect part, there is
no more args, the URL is on the path
2023-08-29 10:37:12 +02:00
Yohan Boniface
5156da6107 doc: add resolver where needed in nginx configuration 2023-08-28 18:10:22 +02:00
Yohan Boniface
949f245c00 1.7.1 2023-08-28 18:00:58 +02:00
Yohan Boniface
eb9aebc4e5 changelog 2023-08-28 16:43:49 +02:00
Yohan Boniface
dbba8d2744
Merge pull request #1280 from umap-project/ajax-proxy-redirect
Use X-Accel-Redirect for serving ajax-proxy request
2023-08-28 16:37:19 +02:00
Yohan Boniface
2904bcc617 More documentation about "ajax-proxy" 2023-08-28 16:36:50 +02:00
Yohan Boniface
e745a7c89b Changelog 2023-08-25 14:24:05 +02:00
Yohan Boniface
7210b1ddb9 Remove useless resolver from nginx config in doc 2023-08-24 17:48:41 +02:00
Yohan Boniface
c4bdb04795 Use X-Accel-Redirect for serving ajax-proxy request
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.

Initially, I wanted this to be totally handled by Nginx, but I never
found a wayt to set the proxy_cache_valid value from a query string.

Since then, at least in OSM France servers, the ajax-proxy is still
handled by a Django view, which then opens the remote URL and transfert
the data. This is not optimal. And I suppose this is what is causing
hicups on the OSM France servers lately.

This PR 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, roughtly:

- the client calls /ajax-proxy/?url=xxx&ttl=300
- python will validate the URL (not internal calls…)
- if UMAP_SENDFILE_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
2023-08-24 13:41:34 +02:00
David Larlet
ccaaa467f1
Use magiclink extension for changelog with links 2023-08-23 09:45:44 -04:00
Yohan Boniface
e73b269217 changelog 2023-08-22 15:38:20 +02:00
Yohan Boniface
ea21857bd3 1.5.1 2023-08-15 23:09:42 +02:00
Yohan Boniface
4acb1aa71e changelog
(Automatically generated by Github)
2023-08-15 16:53:25 +02:00
Yohan Boniface
0c3dc02fc1 Allow to configure default share and edit status
fix #1244
2023-08-07 08:16:49 +02:00
Yohan Boniface
a9d612bf6c 1.4.4 2023-07-22 09:15:21 +02:00
Yohan Boniface
0ec481ed07 1.4.3 2023-07-20 11:49:31 +02:00
Yohan Boniface
34175b89a8 1.4.2 2023-07-19 15:47:25 +02:00
Yohan Boniface
6f667f2749 1.4.1 2023-07-17 16:22:28 +02:00
Yohan Boniface
891c23747f 1.4.0 2023-07-15 11:36:42 +02:00
Yohan Boniface
6429e10110 1.3.7 2023-07-03 22:08:06 +02:00
David Larlet
e03bbeadfc
1.3.6 2023-07-01 11:44:24 -04:00
Yohan Boniface
8c56b91256 Mention UMAP_CUSTOM_* in docs/settings.md 2023-06-29 18:22:09 +02:00
Yohan Boniface
2618b081f7 Add links to Django doc for standard settings 2023-06-29 15:37:40 +02:00
Yohan Boniface
44af4b769b Proofreading settings.md 2023-06-29 15:33:34 +02:00
Yohan Boniface
24de573053
Update docs/settings.md
Co-authored-by: David Larlet <3556+davidbgk@users.noreply.github.com>
2023-06-29 15:28:48 +02:00
Yohan Boniface
b5681f4566
Update docs/settings.md
Co-authored-by: David Larlet <3556+davidbgk@users.noreply.github.com>
2023-06-29 15:28:31 +02:00
Yohan Boniface
a281ea9cb2
Update docs/settings.md
Co-authored-by: David Larlet <3556+davidbgk@users.noreply.github.com>
2023-06-29 15:26:54 +02:00
Yohan Boniface
00796a42f1
Update docs/docker.md
Co-authored-by: David Larlet <3556+davidbgk@users.noreply.github.com>
2023-06-29 15:26:34 +02:00
Yohan Boniface
2084401b6c Add basic doc about settings 2023-06-29 10:30:36 +02:00
Yohan Boniface
93568d6da3 Quick doc about how to upgrade
fix #804
2023-06-23 18:44:06 +02:00
Yohan Boniface
247efc5345 1.3.5 2023-06-17 16:00:57 +02:00
David Larlet
020f805fbe
🚀 1.3.4 2023-06-17 09:46:04 -04:00
David Larlet
e23f1dd3c2
From to setup.cfg+setuptools to pyproject.toml+hatch 2023-06-17 09:09:36 -04:00
Yohan Boniface
81fcc080d9 Allow to customize user display name and URL slug 2023-06-16 14:59:59 +02:00
remco
c0063d2fa2 Fix permisson problem, use suggestion from #407 2023-06-14 21:47:37 +02:00
Yohan Boniface
8ab1c4ea2d 1.3.3 2023-06-07 10:49:27 +02:00
David Larlet
c5b6f8d191
Add dates to the recent changelog 2023-06-06 12:41:11 -04:00
Yohan Boniface
4b502e9857 Merge branch 'docker' 2023-06-05 17:00:46 +02:00
Yohan Boniface
7dac5b2994 Very minimal doc for Docker install 2023-06-05 16:59:49 +02:00
Yohan Boniface
6f1fb4a6ad 1.3.2 2023-06-04 08:54:42 +02:00
Yohan Boniface
90f7680d8d 1.3.1 2023-06-03 08:29:18 +02:00
Yohan Boniface
7c2ba9d3e8 Add doc for email sending 2023-05-31 17:26:48 +02:00
Yohan Boniface
7713281f8c 1.3.0 2023-05-31 10:36:01 +02:00
Yohan Boniface
71293d3d8b changelog 2023-05-31 09:35:00 +02:00
Yohan Boniface
a6a9ff528a changelog 2023-05-16 10:34:43 +02:00
Yohan Boniface
1038836a72 Use Django full text instead of custom SQL 2023-05-11 11:33:08 +02:00
Yohan Boniface
7384fda61a Allow to create search index without changing unaccent mutability
cf #519
2023-05-10 11:47:29 +02:00
Yohan Boniface
b81bbfd3a7 changelog 2023-05-05 18:44:21 +02:00
Yohan Boniface
89e0900148 Review ubuntu packages after fresh install 2023-05-05 15:57:32 +02:00
Yohan Boniface
0f971010bd changelog 2023-05-03 10:10:29 +02:00
Yohan Boniface
5e3a92d173 Control which version of mkdocs is install on readthedocs 2023-04-30 11:35:23 +02:00
David Larlet
2b91373207
[docs] Update the contributing page with DB setup 2023-03-24 11:35:14 -04:00
Yohan Boniface
849e50abc7 changelog 2023-02-28 15:44:01 +01:00
Yohan Boniface
894facc7e3 Document x-accel-redirect and ajax-proxy cache configuration 2023-02-27 12:32:35 +01:00
Esteban
21a972f64c
vendors files information in contributing.md 2022-10-26 18:48:14 +02:00
Matthew Cengia
5dcdab19b1
Update table names in Search/Optimisation docs 2022-03-22 14:58:56 +11:00
Yohan Boniface
953e8eea52 1.2.3 2020-11-09 09:18:44 +01:00
brentfraser
a7241d6459 add note on developing 2020-04-28 11:28:48 -06:00
brentfraser
7e952b0dea typos 2020-04-26 09:46:28 -06:00
brentfraser
c5cd0e1c38 typo 2020-04-26 09:37:04 -06:00
brentfraser
bba5cda46b add Windows install info 2020-04-26 09:34:04 -06:00
Binnette
87ae7d08ae
Merge pull request #778 from umap-project/normalize-keyboard-shortcuts
Normalize keyboard shortcuts
2020-03-31 20:17:11 +02:00
Mathieu Leplatre
f5d30e9793
Fix typos on Install docs
:)
2020-03-31 12:58:48 +02:00
Binnette
e2ca1ecd63 Normalize keyboard shortcuts in translation 2020-03-29 20:17:00 +02:00
Yohan Boniface
bab49715a3 changelog 2020-03-28 11:26:07 +01:00
Yohan Boniface
3fa3473908 1.2.1 2020-03-25 15:14:19 +01:00
Yohan Boniface
ebc3b90d40 1.2.0 2020-03-23 08:39:21 +01:00
Yohan Boniface
cc4ce9ea8c Changelog 2020-03-22 16:53:10 +01:00
Binnette
00d42c5b03
Improve documentation (#746)
Add docs: setup a dev environment and server administration
2020-02-26 21:31:39 +01:00
Binnette
004b10f974 Update transifex url in docs 2020-02-22 23:16:01 +01:00
Lars Lingner
90c7b38114
Update ubuntu from scratch doc
I had to add a config for /static and /uploads folder in nginx when I set DEBUG = False
2019-10-08 10:06:30 +02:00
Yohan Boniface
a6414af1eb 1.1.2 2019-05-11 13:10:57 +02:00
Yohan Boniface
661ce80941 1.1.1 2019-04-16 20:37:40 +02:00
Yohan Boniface
2e56957672 1.1.0 2019-04-07 14:58:22 +02:00
Yohan Boniface
508b63fce5 Merge branch 'master' of github.com:umap-project/umap 2019-02-09 17:29:39 +01:00
Yohan Boniface
5177068de4 Mention in documentation that theme.css is loaded by default 2019-02-09 11:31:31 +01:00
Yohan Boniface
2cc7e01a39 1.0.0-rc.9 2019-02-06 19:41:36 +01:00
Asish Abraham Joseph
7c20190e01
Added missing dependency packages
Added missing ownership to deployment directories
2018-11-15 11:41:58 +05:30
Yohan Boniface
9f11f6cd2d 1.0.0-rc.8 2018-11-04 21:20:29 +01:00
Yohan Boniface
bdbaef123c 1.0.0-rc.7 2018-10-13 14:22:40 +02:00
Yohan Boniface
bf8fb1d3c8 1.0.0-rc.6 2018-09-23 12:02:32 +02:00
Yohan Boniface
d041001168 fixed ternary choice dealing with unknown values (fix #633) 2018-09-11 20:06:35 +02:00
Yohan Boniface
b72650fafe Fix user autocompletion in permissions panel (fix #635) 2018-09-11 19:56:45 +02:00
Yohan Boniface
b54f4efce5 1.0.0-rc.4 2018-09-10 22:42:59 +02:00
Yohan Boniface
0798b708a8 1.0.0-rc.3 2018-09-08 17:07:54 +02:00
Yohan Boniface
7941e8fa60 Add a readonly mode
Activable with UMAP_READONLY=True
2018-09-07 22:12:39 +02:00
Yohan Boniface
3537670221 1.0.0-rc.2 2018-09-05 22:31:01 +02:00
Yohan Boniface
6ad9df8044 Split popupTemplate in popupShape + popupTemplate
cf #600
2018-08-15 17:07:21 +02:00
Yohan Boniface
81f6b429bc allow to cache proxied remote data requests
cf #513
cf #510
cf #160
2018-08-04 20:50:03 +02:00
Yohan Boniface
915a407451 Remove fabfile.py in favor of usine-deploy
https://github.com/umap-project/umap-deploy
2018-07-14 21:12:18 +02:00
Yohan Boniface
4d0baa3697 More details on 1.0.0 upgrade 2018-07-07 23:47:13 +02:00
Yohan Boniface
f05f3ace37 Add TablePanel popup template (fix #481) 2018-07-07 21:44:19 +02:00
Yohan Boniface
8dad057598 Fix caption panel loaded to early in some situations
fix #504
2018-07-07 19:10:13 +02:00
Yohan Boniface
af6c7fba26 Allow to use an unicode char as marker icon symbol
One can also use a property to have a dynamic value (eg.
to display numbers:, 1, 2, 3, 4…).

fix #527
2018-07-07 14:57:56 +02:00
Yohan Boniface
1aca24ed0c Only list https ready tilelayers when page is in https
fix #567
2018-07-07 09:31:50 +02:00
Yohan Boniface
157d25c995 CHANGELOG 2018-06-27 22:21:40 +02:00
Yohan Boniface
fded9d6201 Fix inheritable select not properly reset (fix #551) 2018-06-19 12:41:37 +02:00
Yohan Boniface
cfbe5c0b88 Make TileLayerControl always aware of the map
fix #587
2018-06-16 14:00:27 +02:00
Yohan Boniface
fbb7125167 Merge changelogs and add first changelog for 1.0.0 2018-06-16 13:53:06 +02:00
Yohan Boniface
eeb9fe97c2 Basic documentation on how to customize uMap look&feel 2018-06-16 13:28:13 +02:00
Yohan Boniface
4c8b6f79de Fallback looking for settings file at /etc/umap/umap.conf
fix #487
2017-05-10 19:14:35 +02:00
Yohan Boniface
ea7ecbfc6d Change pip install instruction in doc 2017-02-06 16:34:23 +01:00
Yohan Boniface
049be8ba3e Remove tilelayer and licence creation from the install doc
We now have a data migration to add one default for each
2016-11-26 17:40:42 +01:00
Yohan Boniface
b374ad6479 Add a not in the tutorial about adding more tilelayers and such 2016-11-26 17:39:10 +01:00
Yohan Boniface
8b3d8c5ece Add a migration to create a Licence if none exists 2016-11-26 17:29:00 +01:00
Yohan Boniface
3c32377c42 Add a migration to create a TileLayer if none exists 2016-11-26 17:25:59 +01:00
Yohan Boniface
9de6a6ae0a Tutorial: install from github for now
=
2016-09-24 07:38:57 +02:00
Yohan Boniface
2206c6a1c4 add storagei18n in Ubuntu tutorial 2016-09-11 13:05:38 +02:00
Yohan Boniface
07e6b62012 Ubuntu installation turorial draft 2016-09-10 16:21:09 +02:00
Yohan Boniface
a37d667fd6 Move doc to rtfd 2016-09-10 09:45:12 +02:00
Yohan Boniface
e6bf339c54 Rename project (prepare to 0.1) 2013-01-02 16:20:08 +01:00
Yohan Boniface
0cce7f9e2a First POC 2012-11-20 10:47:19 +01:00