Skip to content

Commit 34e5267

Browse files
committed
Add a simple readme
1 parent 01bba94 commit 34e5267

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
matplotlib.org Hosting
2+
======================
3+
4+
This repo enables matplotlib.org hosting using
5+
[Caddy](https://caddyserver.com/).
6+
7+
By default, Caddy is run in a container using `make serve`, which:
8+
9+
* Runs Caddy (version can be overridden by setting `CADDY_VERSION`) in
10+
[podman](https://podman.io/) (can be switched to docker by setting `RUNTIME`)
11+
* Mounts Matplotlib documentation repositories from the `sites` subdirectory
12+
* Exposes the server on port 2015
13+
14+
Hosted repositories
15+
-------------------
16+
17+
At the top level, Caddy exposes the `mpl-brochure-site` repository with
18+
fallback to files in the `matplotlib.github.com` repository. The following
19+
related projects are also exposed as toplevel directories:
20+
21+
* [basemap](https://github.com/matplotlib/basemap)
22+
* [cheatsheets](https://github.com/matplotlib/cheatsheets)
23+
* [governance](https://github.com/matplotlib/governance)
24+
* [matplotblog](https://github.com/matplotlib/matplotblog)
25+
* [mpl-altair](https://github.com/matplotlib/mpl-altair)
26+
* [mpl-bench](https://github.com/matplotlib/mpl-bench)
27+
* [mpl-third-party](https://github.com/matplotlib/mpl-third-party)
28+
29+
Caddy options
30+
-------------
31+
32+
The Makefile will set these options for you when mounting and running the
33+
container, but if you wish to run Caddy directly, you may wish to set some
34+
overrides in environment variables:
35+
36+
* The host and port with `SITE_ADDRESS` (defaults to port 2015 on all
37+
interfaces)
38+
* The directory containing the git repositories with `SITE_DIR` (defaults to
39+
`sites` in the current directory)

0 commit comments

Comments
 (0)