diff --git a/docs/administration.md b/docs/administration.md new file mode 100644 index 00000000..e58cc113 --- /dev/null +++ b/docs/administration.md @@ -0,0 +1,49 @@ +# Administration + +You can acces uMap administration page by navigating to `https://your.server.org/admin` + +You will have to connect with the admin account create during installation. Default admin username is umap. + +## Pictograms + +Pictograms are icon that can be used in your map markers. + +Pictograms are not embedded in uMap sources, you will have to add them manually. So you can choose which pictograms you want to use. + +Example of pictograms libraries you may want to use: + +- [Maki Icons](https://labs.mapbox.com/maki-icons/) (icon set made for map designers) +- [Osmic Icons](https://gitlab.com/gmgeo/osmic) +- [SJJB Icons](http://www.sjjb.co.uk/mapicons/contactsheet) + +### Import pictograms + +To import pictograms on your uMap server, you will need to use command `umap import_pictograms` + +Note, you can get help with `umap import_pictograms -h` + +In this example, we are gonna import Maki Icons. + +First, we download icons from main site. Inside the downloaded archive, we keep only the icons folder that contains svg files. Place this folder on your server. + +Go inside icons folder and remove tiny icons: `rm *-11.svg` + +Now, we will use imagemagick to convert svg to png. + +`for file in *.svg; do convert -background none $file ${file%15.svg}24.png; done` + +To have white icons use: +`for file in *.svg; do convert -background none -fuzz 100% -fill white -opaque black $file ${file%15.svg}24.png; done` + + +Notes: +- you may also want to resize image with option `-resize 24x` +- this solution is not optimal, generated png are blurry. + +This will convert the svg to png and rename them from *-15.svg to *-24.png + +Now we will import pictograms. Note pictograms names must ends with -24.png + +`umap import_pictograms --attribution "Maki Icons by Mapbox" icons` + +Done. Icons are imported. \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index ddfe693c..be79a976 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -2,6 +2,7 @@ site_name: uMap pages: - Home: index.md - Installation: install.md +- Administration: administration.md - Contributing: contributing.md - how-tos: - Ubuntu from scratch: ubuntu.md