manual icon indicating copy to clipboard operation
manual copied to clipboard

document uberspace command and all its options

Open kimdiallo opened this issue 6 years ago • 2 comments

Explanations of all possible options, like suggested would be nice.

kimdiallo avatar Jan 23 '19 11:01 kimdiallo

Heres the suggestion in a more detailed version as a preview (same was done in #31 in rts):

available options

parameter value description
--apache N/A sets the backend to apache (Default - use for htaccess/Wordpress/etc.)
--static N/A Use the nginx static file server (faster, but no .htaccess)
--http N/A provide a custom http backend listening on a port provided via --port
--port Portnumber Set the port your custom http backend (e.g. 8080)
--remove-prefix N/A removes the prefixed path before passing the url to the backend

Snapstromegon avatar Jan 23 '19 13:01 Snapstromegon

The overall structure of our manual is: I want to do something and there is an article for that with examples on how to do that, from the most basic (and usually sufficient) setup to the most complex example. So there are lots of things you can do with the uberspace command, we cover all (important) options in the articles step by step.

An explanation for all options (and maybe a look behind the scenes) for all subcommands, including backend, should be a background article and maybe even generated and thus kept up to date from the uberspace tool itself to have a single source of truth. @luto thoughts?

nichtmax avatar Apr 09 '19 08:04 nichtmax