search

fungover / storm

A simple webserver implementation
MIT License
1 stars 12 forks source link

Document how to run #45

Open kappsegla opened 2 years ago

kappsegla commented 2 years ago

We should have some documentation about how to run this application.

Could be added to the README.md file showing the commands needed for running the application with java and how to run it using docker. After adding publishing of a docker image to github docker repository later we should also have the url for the docker image listed in the documentation.

LukasFinne commented 2 years ago

Is there any like guidelines to how to write a documentation for an application correctly?

Vimbayinashe commented 2 years ago

Is there any like guidelines to how to write a documentation for an application correctly?

These two README files may be used for help regarding the layout, Kappsegla's server README and Kappsegla's Maven Template README.

kappsegla commented 2 years ago

Can also take some inspiration from dockerhub documentation for instructions how to run a docker image. https://hub.docker.com/_/nginx

Here are documentation about README.md format: https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax

Things that should be documented are:

How to pull the latest version of our image

How to run it with docker run, don't forget portmapping. (-p 8080:8080)

Optional environment variables that can be set. (Portnumber)

Mount points:

/webroot for mounting a websites pages. If creating a file called 404.html here it will be used when the server can't find other files.

/etc/storm/config/ If we mount a folder containing a file named config.json here we can change some parameters for the server like port number.