flood icon indicating copy to clipboard operation
flood copied to clipboard

Documentation about the docker container

Open noraj opened this issue 7 years ago • 4 comments

Summary

As @jfurrow asked in #79 it would be great to have some documentation about docker :

I agree, you all have done some awesome work. It's probably best to consolidate these in a wiki article for Flood. If one of you would like to start it, I'd be super grateful, but otherwise I'll get to it ASAP.

Thanks, everyone, for the awesome dockerfiles!

Expected Behavior

Help is wanted to create a documentation about the Flood docker container. At least we need to document :

  • Docker installation steps / basic deployments
  • Docker configuration (describe supported environment variables, etc...)

Current Behavior

There is no documentation about Flood container.

Possible Solution

You will be thanked if you can complete this wiki page.

noraj avatar Mar 29 '18 17:03 noraj

I made a start for Installation, Configuration and Architecture.

noraj avatar Mar 29 '18 17:03 noraj

#666 May require more documentation.

noraj avatar May 11 '18 20:05 noraj

I would like to help, but is it appropriate to add a page describing compete setup that include rtorrent, flood, possibly nginx proxy and certbot?

http403 avatar Oct 17 '18 03:10 http403

There is mainly to audience:

  • User: How to use the docker image (parameters, how to run it, etc.)
  • Dev: Architecture, interactions between rtorrent, flood, proxy, cerbot etc.

noraj avatar Oct 17 '18 18:10 noraj