697bffd6a9
* Set REMOTE_ADDR correctly when requests are going through a CDN Shield https://www.fastly.com/documentation/guides/concepts/shielding/ CDN Shield is an additional PoP requests can go through, and their IP is added to X-Forwarded-For so we need to look for the client IP in a different place. The special X-AMO-Request-Shielded header is set to "true" in that case. * Tweak documentation about IP addresses and move them from middleware docstring to their own doc |
||
|---|---|---|
| .. | ||
| _intersphinx | ||
| _static | ||
| _templates | ||
| extensions | ||
| screenshots | ||
| settings | ||
| topics | ||
| Makefile | ||
| README.md | ||
| __init__.py | ||
| build-github.zsh | ||
| conf.py | ||
| index.md | ||
| watcher.py | ||
README.md
Add-ons Server Documentation
This is the documentation for the use of the addons-server and its services. All documentation is in plain text files using primarily myST and is built using Sphinx. Some docs, especially API docs are still written using standard reStructuredText but most future documentation should be written in markdown.
If you're unsure, activate your virtualenv and run:
make update_deps
The documentation is viewable at http://addons-server.readthedocs.io/, and covers development using Add-ons Server, the source code for Add-ons.
Its source location is in the /docs folder.
Note: this project was once called olympia, this documentation often uses that term.
Build the documentation
This is as simple as running:
make docs
This is the same as cd'ing to the docs folder, and running make html from there.
We include a daemon that can watch and regenerate the built HTML when
documentation source files change. To use it, go to the docs folder
and run:
python watcher.py 'make html' $(find . -name '*.rst')
Once done, check the result by opening the following file in your browser:
/path/to/olympia/docs/_build/html/index.html