WIP: Add docker-compose.yml and fix nginx paths for resources (Issue #211)

[ajlennon]

What?

Allows a user to locally build and run a docker container hosting the documentation webserver

Why?

Makes it easy to build and run the documentation server locally without making host OS changes

Examples

How to test

docker compose build
docker compose up

Then browse to localhost:8080/docs

NOTE I don't know if these changes break the CI deployment to the official server

Documentation of functionality

N/A

Limitations

Might impact CI deployment

Alternatives considered

Open questions

Does this impact CI deployment

Additional details or related context

[DougReeder]

An unfortunate complication is that Hubs in some places refers to /docs/ URLs. I think the current image would be great running on a Hubs instance, and we want to keep that. However, like you, we'd like it to be able to run independently as well.

[Exairnous]

I believe the issue with building the Docker image is because of us moving away from using /docs/. This was introduced with #203 but no one thought about updating the Docker image or its nginx configuration. So I think that rather than adding more redirects for /docs/ we should be removing them. Actually, it looks like modifying the initial redirect to the following should make everything work again (and no other redirects should be needed):

location / {
        root /var/www/docs;
        autoindex off;
        add_header 'Access-Control-Allow-Origin' '*';
    }

@DougReeder Does the above seem plausible to you and in line with your changes?

[DougReeder]

Consider whethere exposing the server on port 80 would make sense.

[DougReeder]

location / {
        root /var/www/docs;
        autoindex off;
        add_header 'Access-Control-Allow-Origin' '*';
    }

That's cleaner.

I think it should be root /var/www;, please test that.

[Exairnous]

Using /var/www returns a 403 forbidden error if you go to localhost:8080 and if you go to localhost:8080/docs the welcome page will display, but it will fail to find the css, js, ico files, etc.. If you exec into the container, you'll see that everything is housed within /var/www/docs. So more changes would be required to shift everything to the www folder, if we wanted to do that, but I don't think grouping everything within a docs subfolder in the server is a bad thing. I think we just want to avoid the docs subdirectory in the URL?