Alexis Métaireau
3e63768fc0
docs: clarify how to use JS libs
2024-01-15 14:58:43 +01:00
Alexis Métaireau
de8e806b28
docs: document how dependencies are handled
2024-01-15 14:44:55 +01:00
Yohan Boniface
4c5b94d572
Merge pull request #1511 from umap-project/docs/template-changes
...
docs: document changed templates
2024-01-13 18:52:09 +01:00
Alexis Métaireau
b75e3bedd7
docs: include the release process
2024-01-11 11:56:13 +01:00
Stephan Geisler
e40d4584f9
fix typo in settings.md
2024-01-11 11:48:48 +01:00
Stephan Geisler
2c94f6afbe
Update settings.md
...
Description added on how to create a superuser in order to be able to use the ENABLE_ACCOUNT_LOGIN parameter (result of issue: #1520 )
2024-01-11 11:48:48 +01:00
Yohan Boniface
20814dd73c
changelog
2024-01-08 16:52:56 +01:00
Alexis Métaireau
aef8afee6c
docs: document changed templates
2024-01-08 16:51:41 +01:00
Yohan Boniface
16a42025b5
changelog
2024-01-08 13:51:14 +01:00
Yohan Boniface
1d32e52386
Refactor changelog
2023-12-29 11:38:13 +01:00
Yohan Boniface
defb956e7e
changelog
2023-12-29 11:25:24 +01:00
David Larlet
f034477e08
Fix the changelog for mkdocs rendering
2023-12-26 10:39:23 -05:00
Yohan Boniface
5f744848ac
changelog
2023-12-23 09:20:45 +01:00
Yohan Boniface
45f0fdc03f
changelog
2023-12-17 10:11:53 +01:00
Alexis Métaireau
f3c67b54b6
[docs] Add some testing information
2023-12-15 17:00:50 +00:00
David Larlet
1fccbb7d59
Better changelog rendering
2023-12-06 12:46:32 -05:00
Alexis Métaireau
d15c436d42
[chore] fix docs requirements
2023-12-06 11:04:15 +00:00
Alexis Métaireau
e4ad904536
Merge pull request #1440 from umap-project/almet/rework-docs
2023-12-06 10:40:24 +00:00
Alexis Métaireau
ce4b411cec
Update docs/contributing.md
...
Co-authored-by: Yohan Boniface <yb@enix.org>
2023-12-05 23:13:27 +01:00
Alexis Métaireau
b04ad69276
Update docs/config/settings.md
...
Co-authored-by: Yohan Boniface <yb@enix.org>
2023-12-05 23:12:40 +01:00
Alexis Métaireau
18afcad918
Update docs/config/customize.md
...
Co-authored-by: Yohan Boniface <yb@enix.org>
2023-12-05 23:12:28 +01:00
Alexis Métaireau
4676fd09e6
Update docs/architecture/overview.md
...
Co-authored-by: Yohan Boniface <yb@enix.org>
2023-12-05 23:12:09 +01:00
Alexis Métaireau
c058db8ae2
[docs] Rework the documentation
2023-12-05 16:18:10 +01:00
David Larlet
8804a953ee
[docs] Adapt primary color to match uMap one
2023-11-28 21:40:09 -05:00
Alexis Métaireau
b3d6d6da08
[docs] Update the documentation
2023-11-28 15:54:11 +01:00
Yohan Boniface
3c3a99ba6e
changelog
2023-11-27 10:24:00 +01:00
Yohan Boniface
fc64551c82
Add in documentation example of filtering headers in ajax proxy conf
2023-11-23 17:03:16 +01:00
Yohan Boniface
a77a6a137f
Update search index command in documentation
...
Sadly, when using a SearchVector, Django will introduce a COALESCE
that will then prevent our index to be used. So we need to add
this COALESCE in the index to make psql happy.
fix #1414
2023-11-21 10:40:55 +01:00
Yohan Boniface
173c1315a4
Fix documentation formating
2023-11-21 10:28:27 +01:00
Yohan Boniface
66ee9c736e
changelog
2023-11-20 11:38:53 +01:00
Yohan Boniface
3034ebc50b
Merge pull request #1388 from umap-project/pictogram-category
...
Pictogram category
2023-11-07 18:01:15 +01:00
Alexis Métaireau
4f00981293
Update installation instructions
2023-11-06 12:15:05 +01:00
Yohan Boniface
de8bbc2851
Update docs/administration.md
...
Co-authored-by: David Larlet <3556+davidbgk@users.noreply.github.com>
2023-10-30 22:28:15 +01:00
Yohan Boniface
15eea6ead9
Apply suggestions from code review
...
Co-authored-by: David Larlet <3556+davidbgk@users.noreply.github.com>
2023-10-30 21:51:05 +01:00
Yohan Boniface
f61f1415ce
Update pictograms import script to deal with category and SVG
2023-10-30 21:35:22 +01:00
Yohan Boniface
c9f767b6de
changelog
2023-10-27 20:12:38 +02:00
Yohan Boniface
2bca26cbe7
changelog
2023-10-18 09:16:42 +02:00
Yohan Boniface
ddbcdbcde7
changelog
2023-10-12 11:47:04 +02:00
Yohan Boniface
5f9d7d3ec3
changelog
2023-10-12 10:14:57 +02:00
Yohan Boniface
07031595e7
changelog
2023-10-12 09:23:45 +02:00
Yohan Boniface
4e3a22dc11
changelog
2023-09-27 07:28:03 +02:00
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
