Skip to content

Commit

Permalink
Add documentation for Screamshotter and Convertit
Browse files Browse the repository at this point in the history
  • Loading branch information
PON authored and PON committed Sep 14, 2023
1 parent 2f04b5b commit 4db2165
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 4 deletions.
4 changes: 4 additions & 0 deletions CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ CHANGELOG
* Drop django 3.1 support
* Ease quickstart for developers

**Minor fixes**

- Improve authentication mechanism for screamshotter and convertit


8.5.6 (2023-09-04)
-----------------------
Expand Down
30 changes: 26 additions & 4 deletions docs/development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,32 @@ Development

Quickstart to run MapEntity in development :

$ docker-compose build
$ docker-compose run --rm web ./manage.py migrate
$ docker-compose run --rm web ./manage.py createsuperuser
$ docker-compose up
::
docker-compose build
docker-compose run --rm web ./manage.py migrate
docker-compose run --rm web ./manage.py createsuperuser
docker-compose run --rm web ./manage.py update_permissions_mapentity
docker-compose up

Get Screamshotter and convertit working:

To make the Screamshotter container work, it needs to access your web container by using your browser's URL.

If you use http://localhost:8000/ for development, it attempts to access itself to capture the web application.
To make it work in the development environment, you should use mapentity.local.



add in your /etc/hosts file :


127.0.0.1 mapentity.local

Then use http://mapentity.local:8000 in your browser


In production, if you use public domain (ex: http://mapentity.com, screamshotter will try to get capture from this
domain, so no problem will occur if this domain is public.


Release
Expand Down

0 comments on commit 4db2165

Please sign in to comment.