diff options
author | Steve Manuel <nilslice@gmail.com> | 2017-06-10 16:05:43 -0700 |
---|---|---|
committer | Steve Manuel <nilslice@gmail.com> | 2017-06-10 16:05:43 -0700 |
commit | a5c4288a8c743cac1637184b252595f150fb6748 (patch) | |
tree | e65b5a0dc7579b0af904c487570c5c5ade742f7b /docs | |
parent | 0c395e5df3f82037fbdc6076df87d81ea5921574 (diff) |
update docs with docs flag documentation
Diffstat (limited to 'docs')
-rw-r--r-- | docs/build/CLI/General-Usage/index.html | 16 | ||||
-rw-r--r-- | docs/build/mkdocs/search_index.json | 4 | ||||
-rw-r--r-- | docs/build/sitemap.xml | 44 | ||||
-rw-r--r-- | docs/src/CLI/General-Usage.md | 5 |
4 files changed, 38 insertions, 31 deletions
diff --git a/docs/build/CLI/General-Usage/index.html b/docs/build/CLI/General-Usage/index.html index 884336a..3e583c0 100644 --- a/docs/build/CLI/General-Usage/index.html +++ b/docs/build/CLI/General-Usage/index.html @@ -1047,11 +1047,15 @@ The segments, separated by a comma, describe which services to start, either 'admin' (Admin System / CMS backend) or 'api' (JSON API), and, optionally, if the server should utilize TLS encryption - served over HTTPS, which is automatically managed using Let's Encrypt (https://letsencrypt.org) </p> -<p>Optional flags: -- <code>--port</code> sets the port on which the server listens for HTTP requests [defaults to 8080] -- <code>--https-port</code> sets the port on which the server listens for HTTPS requests [defaults to 443] -- <code>--https</code> enables auto HTTPS management via Let's Encrypt (port is always 443) -- <code>--dev-https</code> generates self-signed SSL certificates for development-only (port is 10443)</p> +<p>Optional flags:</p> +<ul> +<li><code>--port</code> sets the port on which the server listens for HTTP requests [defaults to 8080]</li> +<li><code>--https-port</code> sets the port on which the server listens for HTTPS requests [defaults to 443]</li> +<li><code>--https</code> enables auto HTTPS management via Let's Encrypt (port is always 443)</li> +<li><code>--dev-https</code> generates self-signed SSL certificates for development-only (port is 10443)</li> +<li><code>--docs</code> runs a local documentation server in case of no network connection</li> +<li><code>--docs-port</code> sets the port on which the docs server listens for HTTP requests [defaults to 1234]</li> +</ul> <p>Example: </p> <div class="codehilite"><pre><span></span>$ ponzu run <span class="o">(</span>or<span class="o">)</span> @@ -1061,7 +1065,7 @@ $ ponzu run admin <span class="o">(</span>or<span class="o">)</span> $ ponzu run --port<span class="o">=</span><span class="m">8888</span> api <span class="o">(</span>or<span class="o">)</span> -$ ponzu --dev-https run +$ ponzu run --dev-https </pre></div> diff --git a/docs/build/mkdocs/search_index.json b/docs/build/mkdocs/search_index.json index b9dca9c..b115dd1 100644 --- a/docs/build/mkdocs/search_index.json +++ b/docs/build/mkdocs/search_index.json @@ -27,7 +27,7 @@ }, { "location": "/CLI/General-Usage/", - "text": "$ ponzu \n[\nflags\n]\n \ncommand\n \nparams\n\n\n\n\n\n\nCommands\n\n\nnew\n\n\nCreates a project directory of the name supplied as a parameter immediately\nfollowing the 'new' option in the $GOPATH/src directory. Note: 'new' depends on \nthe program 'git' and possibly a network connection. If there is no local \nrepository to clone from at the local machine's $GOPATH, 'new' will attempt to \nclone the 'github.com/ponzu-cms/ponzu' package from over the network.\n\n\nExample:\n\n\n$ ponzu new github.com/nilslice/proj\n\n New ponzu project created at \n$GOPATH\n/src/github.com/nilslice/proj\n\n\n\n\n\n\n\ngenerate, gen, g\n\n\nGenerate boilerplate code for various Ponzu components, such as \ncontent\n.\n\n\nExample:\n\n\n generator struct fields and built-in types...\n \n|\n \n|\n\n v v \n$ ponzu gen content review title:\nstring\n body:\nstring\n:richtext rating:\nint\n\n ^ ^\n \n|\n \n|\n\n struct \ntype\n \n(\noptional\n)\n input view specifier\n\n\n\n\n\nThe command above will generate the file \ncontent/review.go\n with boilerplate\nmethods, as well as struct definition, and corresponding field tags like:\n\n\ntype\n \nReview\n \nstruct\n \n{\n\n \nitem\n.\nItem\n\n\n \nTitle\n \nstring\n \n`json:\ntitle\n`\n\n \nBody\n \nstring\n \n`json:\nbody\n`\n\n \nRating\n \nint\n \n`json:\nrating\n`\n\n \nTags\n \n[]\nstring\n \n`json:\ntags\n`\n\n\n}\n\n\n\n\n\n\nThe generate command will intelligently parse more sophisticated field names\nsuch as 'field_name' and convert it to 'FieldName' and vice versa, only where \nappropriate as per common Go idioms. Errors will be reported, but successful \ngenerate commands return nothing.\n\n\nInput View Specifiers\n \n(optional)\n\n\nThe CLI can optionally parse a third parameter on the fields provided to generate \nthe type of HTML view an editor field is presented within. If no third parameter\nis added, a plain text HTML input will be generated. In the example above, the \nargument shown as \nbody:string:richtext\n would show the Richtext input instead\nof a plain text HTML input (as shown in the screenshot). The following input\nview specifiers are implemented:\n\n\n\n\n\n\n\n\nCLI parameter\n\n\nGenerates\n\n\n\n\n\n\n\n\n\n\ncheckbox\n\n\neditor.Checkbox()\n\n\n\n\n\n\ncustom\n\n\ngenerates a pre-styled empty div to fill with HTML\n\n\n\n\n\n\nfile\n\n\neditor.File()\n\n\n\n\n\n\nhidden\n\n\neditor.Input()\n + uses type=hidden\n\n\n\n\n\n\ninput, text\n\n\neditor.Input()\n\n\n\n\n\n\nrichtext\n\n\neditor.Richtext()\n\n\n\n\n\n\nselect\n\n\neditor.Select()\n\n\n\n\n\n\ntextarea\n\n\neditor.Textarea()\n\n\n\n\n\n\ntags\n\n\neditor.Tags()\n\n\n\n\n\n\n\n\nGenerate Content References\n\n\nIt's also possible to generate all of the code needed to create references between\nyour content types. The syntax to do so is below, but refer to the \ndocumentation\n\nfor more details:\n\n\n$ ponzu gen c author name:string genre:string:select\n$ ponzu gen c book title:string author:@author,name,genre \n\n\n\n\n\nThe commands above will generate a \nBook\n Content type with a reference to an\n\nAuthor\n item, by also generating a \nreference.Select\n\nas the view for the \nauthor\n field.\n\n\n\n\nbuild\n\n\nFrom within your Ponzu project directory, running build will copy and move \nthe necessary files from your workspace into the vendored directory, and \nwill build/compile the project to then be run. \n\n\nOptional flags:\n- \n--gocmd\n sets the binary used when executing \ngo build\n within \nponzu\n build step\n\n\nExample:\n\n\n$ ponzu build\n\n(\nor\n)\n\n$ ponzu build --gocmd\n=\ngo1.8rc1 \n# useful for testing\n\n\n\n\n\n\nErrors will be reported, but successful build commands return nothing.\n\n\n\n\nrun\n\n\nStarts the HTTP server for the JSON API, Admin System, or both.\nThe segments, separated by a comma, describe which services to start, either \n'admin' (Admin System / CMS backend) or 'api' (JSON API), and, optionally, \nif the server should utilize TLS encryption - served over HTTPS, which is\nautomatically managed using Let's Encrypt (https://letsencrypt.org) \n\n\nOptional flags:\n- \n--port\n sets the port on which the server listens for HTTP requests [defaults to 8080]\n- \n--https-port\n sets the port on which the server listens for HTTPS requests [defaults to 443]\n- \n--https\n enables auto HTTPS management via Let's Encrypt (port is always 443)\n- \n--dev-https\n generates self-signed SSL certificates for development-only (port is 10443)\n\n\nExample: \n\n\n$ ponzu run\n\n(\nor\n)\n\n$ ponzu run --port\n=\n8080\n --https admin,api\n\n(\nor\n)\n \n$ ponzu run admin\n\n(\nor\n)\n\n$ ponzu run --port\n=\n8888\n api\n\n(\nor\n)\n\n$ ponzu --dev-https run\n\n\n\n\n\nDefaults to \n$ ponzu run --port=8080 admin,api\n (running Admin \n API on port 8080, without TLS)\n\n\nNote:\n \nAdmin and API cannot run on separate processes unless you use a copy of the\ndatabase, since the first process to open it receives a lock. If you intend\nto run the Admin and API on separate processes, you must call them with the\n'ponzu' command independently.\n\n\n\n\nupgrade\n\n\nWill backup your own custom project code (like content, addons, uploads, etc) so\nwe can safely re-clone Ponzu from the latest version you have or from the network \nif necessary. Before running \n$ ponzu upgrade\n, you should update the \nponzu\n\npackage by running \n$ go get -u github.com/ponzu-cms/ponzu/...\n \n\n\nExample:\n\n\n$ ponzu upgrade\n\n\n\n\n\n\n\nadd, a\n\n\nDownloads an addon to GOPATH/src and copies it to the current Ponzu project's\n\n/addons\n directory.\n\n\nExample:\n\n\n$ ponzu add github.com/bosssauce/fbscheduler\n\n\n\n\n\nErrors will be reported, but successful add commands return nothing.\n\n\n\n\nversion, v\n\n\nPrints the version of Ponzu your project is using. Must be called from within a \nPonzu project directory. By passing the \n--cli\n flag, the \nversion\n command will \nprint the version of the Ponzu CLI you have installed.\n\n\nExample:\n\n\n$ ponzu version\nPonzu v0.8.2\n\n# (or)\n\n$ ponzu version --cli\nPonzu v0.9.2\n\n\n\n\n\n\n\nContributing\n\n\n\n\nCheckout branch ponzu-dev\n\n\nMake code changes\n\n\nTest changes to ponzu-dev branch\n\n\nmake a commit to ponzu-dev\n\n\nto manually test, you will need to use a new copy (ponzu new path/to/code), \nbut pass the \n--dev\n flag so that ponzu generates a new copy from the \nponzu-dev\n \nbranch, not master by default (i.e. \n$ponzu new --dev /path/to/code\n)\n\n\nbuild and run with \n$ ponzu build\n and \n$ ponzu run\n\n\n\n\n\n\nTo add back to master: \n\n\nfirst push to origin ponzu-dev\n\n\ncreate a pull request \n\n\nwill then be merged into master\n\n\n\n\n\n\n\n\nA typical contribution workflow might look like:\n\n\n# clone the repository and checkout ponzu-dev\n\n$ git clone https://github.com/ponzu-cms/ponzu path/to/local/ponzu \n# (or your fork)\n\n$ git checkout ponzu-dev\n\n\n# install ponzu with go get or from your own local path\n\n$ go get github.com/ponzu-cms/ponzu/...\n\n# or\n\n$ \ncd\n /path/to/local/ponzu \n$ go install ./...\n\n\n# edit files, add features, etc\n\n$ git add -A\n$ git commit -m \nedited files, added features, etc\n\n\n\n# now you need to test the feature.. make a new ponzu project, but pass --dev flag\n\n$ ponzu --dev new /path/to/new/project \n# will create $GOPATH/src/path/to/new/project\n\n\n\n# build \n run ponzu from the new project directory\n\n$ \ncd\n /path/to/new/project\n$ ponzu build \n ponzu run\n\n\n# push to your origin:ponzu-dev branch and create a PR at ponzu-cms/ponzu\n\n$ git push origin ponzu-dev\n\n# ... go to https://github.com/ponzu-cms/ponzu and create a PR\n\n\n\n\n\n\nNote:\n if you intend to work on your own fork and contribute from it, you will\nneed to also pass \n--fork=path/to/your/fork\n (using OS-standard filepath structure),\nwhere \npath/to/your/fork\n \nmust\n be within \n$GOPATH/src\n, and you are working from a branch\ncalled \nponzu-dev\n. \n\n\nFor example: \n\n\n# ($GOPATH/src is implied in the fork path, do not add it yourself)\n\n$ ponzu new --dev --fork\n=\ngithub.com/nilslice/ponzu /path/to/new/project", + "text": "$ ponzu \n[\nflags\n]\n \ncommand\n \nparams\n\n\n\n\n\n\nCommands\n\n\nnew\n\n\nCreates a project directory of the name supplied as a parameter immediately\nfollowing the 'new' option in the $GOPATH/src directory. Note: 'new' depends on \nthe program 'git' and possibly a network connection. If there is no local \nrepository to clone from at the local machine's $GOPATH, 'new' will attempt to \nclone the 'github.com/ponzu-cms/ponzu' package from over the network.\n\n\nExample:\n\n\n$ ponzu new github.com/nilslice/proj\n\n New ponzu project created at \n$GOPATH\n/src/github.com/nilslice/proj\n\n\n\n\n\n\n\ngenerate, gen, g\n\n\nGenerate boilerplate code for various Ponzu components, such as \ncontent\n.\n\n\nExample:\n\n\n generator struct fields and built-in types...\n \n|\n \n|\n\n v v \n$ ponzu gen content review title:\nstring\n body:\nstring\n:richtext rating:\nint\n\n ^ ^\n \n|\n \n|\n\n struct \ntype\n \n(\noptional\n)\n input view specifier\n\n\n\n\n\nThe command above will generate the file \ncontent/review.go\n with boilerplate\nmethods, as well as struct definition, and corresponding field tags like:\n\n\ntype\n \nReview\n \nstruct\n \n{\n\n \nitem\n.\nItem\n\n\n \nTitle\n \nstring\n \n`json:\ntitle\n`\n\n \nBody\n \nstring\n \n`json:\nbody\n`\n\n \nRating\n \nint\n \n`json:\nrating\n`\n\n \nTags\n \n[]\nstring\n \n`json:\ntags\n`\n\n\n}\n\n\n\n\n\n\nThe generate command will intelligently parse more sophisticated field names\nsuch as 'field_name' and convert it to 'FieldName' and vice versa, only where \nappropriate as per common Go idioms. Errors will be reported, but successful \ngenerate commands return nothing.\n\n\nInput View Specifiers\n \n(optional)\n\n\nThe CLI can optionally parse a third parameter on the fields provided to generate \nthe type of HTML view an editor field is presented within. If no third parameter\nis added, a plain text HTML input will be generated. In the example above, the \nargument shown as \nbody:string:richtext\n would show the Richtext input instead\nof a plain text HTML input (as shown in the screenshot). The following input\nview specifiers are implemented:\n\n\n\n\n\n\n\n\nCLI parameter\n\n\nGenerates\n\n\n\n\n\n\n\n\n\n\ncheckbox\n\n\neditor.Checkbox()\n\n\n\n\n\n\ncustom\n\n\ngenerates a pre-styled empty div to fill with HTML\n\n\n\n\n\n\nfile\n\n\neditor.File()\n\n\n\n\n\n\nhidden\n\n\neditor.Input()\n + uses type=hidden\n\n\n\n\n\n\ninput, text\n\n\neditor.Input()\n\n\n\n\n\n\nrichtext\n\n\neditor.Richtext()\n\n\n\n\n\n\nselect\n\n\neditor.Select()\n\n\n\n\n\n\ntextarea\n\n\neditor.Textarea()\n\n\n\n\n\n\ntags\n\n\neditor.Tags()\n\n\n\n\n\n\n\n\nGenerate Content References\n\n\nIt's also possible to generate all of the code needed to create references between\nyour content types. The syntax to do so is below, but refer to the \ndocumentation\n\nfor more details:\n\n\n$ ponzu gen c author name:string genre:string:select\n$ ponzu gen c book title:string author:@author,name,genre \n\n\n\n\n\nThe commands above will generate a \nBook\n Content type with a reference to an\n\nAuthor\n item, by also generating a \nreference.Select\n\nas the view for the \nauthor\n field.\n\n\n\n\nbuild\n\n\nFrom within your Ponzu project directory, running build will copy and move \nthe necessary files from your workspace into the vendored directory, and \nwill build/compile the project to then be run. \n\n\nOptional flags:\n- \n--gocmd\n sets the binary used when executing \ngo build\n within \nponzu\n build step\n\n\nExample:\n\n\n$ ponzu build\n\n(\nor\n)\n\n$ ponzu build --gocmd\n=\ngo1.8rc1 \n# useful for testing\n\n\n\n\n\n\nErrors will be reported, but successful build commands return nothing.\n\n\n\n\nrun\n\n\nStarts the HTTP server for the JSON API, Admin System, or both.\nThe segments, separated by a comma, describe which services to start, either \n'admin' (Admin System / CMS backend) or 'api' (JSON API), and, optionally, \nif the server should utilize TLS encryption - served over HTTPS, which is\nautomatically managed using Let's Encrypt (https://letsencrypt.org) \n\n\nOptional flags:\n\n\n\n\n--port\n sets the port on which the server listens for HTTP requests [defaults to 8080]\n\n\n--https-port\n sets the port on which the server listens for HTTPS requests [defaults to 443]\n\n\n--https\n enables auto HTTPS management via Let's Encrypt (port is always 443)\n\n\n--dev-https\n generates self-signed SSL certificates for development-only (port is 10443)\n\n\n--docs\n runs a local documentation server in case of no network connection\n\n\n--docs-port\n sets the port on which the docs server listens for HTTP requests [defaults to 1234]\n\n\n\n\nExample: \n\n\n$ ponzu run\n\n(\nor\n)\n\n$ ponzu run --port\n=\n8080\n --https admin,api\n\n(\nor\n)\n \n$ ponzu run admin\n\n(\nor\n)\n\n$ ponzu run --port\n=\n8888\n api\n\n(\nor\n)\n\n$ ponzu run --dev-https\n\n\n\n\n\nDefaults to \n$ ponzu run --port=8080 admin,api\n (running Admin \n API on port 8080, without TLS)\n\n\nNote:\n \nAdmin and API cannot run on separate processes unless you use a copy of the\ndatabase, since the first process to open it receives a lock. If you intend\nto run the Admin and API on separate processes, you must call them with the\n'ponzu' command independently.\n\n\n\n\nupgrade\n\n\nWill backup your own custom project code (like content, addons, uploads, etc) so\nwe can safely re-clone Ponzu from the latest version you have or from the network \nif necessary. Before running \n$ ponzu upgrade\n, you should update the \nponzu\n\npackage by running \n$ go get -u github.com/ponzu-cms/ponzu/...\n \n\n\nExample:\n\n\n$ ponzu upgrade\n\n\n\n\n\n\n\nadd, a\n\n\nDownloads an addon to GOPATH/src and copies it to the current Ponzu project's\n\n/addons\n directory.\n\n\nExample:\n\n\n$ ponzu add github.com/bosssauce/fbscheduler\n\n\n\n\n\nErrors will be reported, but successful add commands return nothing.\n\n\n\n\nversion, v\n\n\nPrints the version of Ponzu your project is using. Must be called from within a \nPonzu project directory. By passing the \n--cli\n flag, the \nversion\n command will \nprint the version of the Ponzu CLI you have installed.\n\n\nExample:\n\n\n$ ponzu version\nPonzu v0.8.2\n\n# (or)\n\n$ ponzu version --cli\nPonzu v0.9.2\n\n\n\n\n\n\n\nContributing\n\n\n\n\nCheckout branch ponzu-dev\n\n\nMake code changes\n\n\nTest changes to ponzu-dev branch\n\n\nmake a commit to ponzu-dev\n\n\nto manually test, you will need to use a new copy (ponzu new path/to/code), \nbut pass the \n--dev\n flag so that ponzu generates a new copy from the \nponzu-dev\n \nbranch, not master by default (i.e. \n$ponzu new --dev /path/to/code\n)\n\n\nbuild and run with \n$ ponzu build\n and \n$ ponzu run\n\n\n\n\n\n\nTo add back to master: \n\n\nfirst push to origin ponzu-dev\n\n\ncreate a pull request \n\n\nwill then be merged into master\n\n\n\n\n\n\n\n\nA typical contribution workflow might look like:\n\n\n# clone the repository and checkout ponzu-dev\n\n$ git clone https://github.com/ponzu-cms/ponzu path/to/local/ponzu \n# (or your fork)\n\n$ git checkout ponzu-dev\n\n\n# install ponzu with go get or from your own local path\n\n$ go get github.com/ponzu-cms/ponzu/...\n\n# or\n\n$ \ncd\n /path/to/local/ponzu \n$ go install ./...\n\n\n# edit files, add features, etc\n\n$ git add -A\n$ git commit -m \nedited files, added features, etc\n\n\n\n# now you need to test the feature.. make a new ponzu project, but pass --dev flag\n\n$ ponzu --dev new /path/to/new/project \n# will create $GOPATH/src/path/to/new/project\n\n\n\n# build \n run ponzu from the new project directory\n\n$ \ncd\n /path/to/new/project\n$ ponzu build \n ponzu run\n\n\n# push to your origin:ponzu-dev branch and create a PR at ponzu-cms/ponzu\n\n$ git push origin ponzu-dev\n\n# ... go to https://github.com/ponzu-cms/ponzu and create a PR\n\n\n\n\n\n\nNote:\n if you intend to work on your own fork and contribute from it, you will\nneed to also pass \n--fork=path/to/your/fork\n (using OS-standard filepath structure),\nwhere \npath/to/your/fork\n \nmust\n be within \n$GOPATH/src\n, and you are working from a branch\ncalled \nponzu-dev\n. \n\n\nFor example: \n\n\n# ($GOPATH/src is implied in the fork path, do not add it yourself)\n\n$ ponzu new --dev --fork\n=\ngithub.com/nilslice/ponzu /path/to/new/project", "title": "General Usage" }, { @@ -52,7 +52,7 @@ }, { "location": "/CLI/General-Usage/#run", - "text": "Starts the HTTP server for the JSON API, Admin System, or both.\nThe segments, separated by a comma, describe which services to start, either \n'admin' (Admin System / CMS backend) or 'api' (JSON API), and, optionally, \nif the server should utilize TLS encryption - served over HTTPS, which is\nautomatically managed using Let's Encrypt (https://letsencrypt.org) Optional flags:\n- --port sets the port on which the server listens for HTTP requests [defaults to 8080]\n- --https-port sets the port on which the server listens for HTTPS requests [defaults to 443]\n- --https enables auto HTTPS management via Let's Encrypt (port is always 443)\n- --dev-https generates self-signed SSL certificates for development-only (port is 10443) Example: $ ponzu run ( or ) \n$ ponzu run --port = 8080 --https admin,api ( or ) \n$ ponzu run admin ( or ) \n$ ponzu run --port = 8888 api ( or ) \n$ ponzu --dev-https run Defaults to $ ponzu run --port=8080 admin,api (running Admin API on port 8080, without TLS) Note: \nAdmin and API cannot run on separate processes unless you use a copy of the\ndatabase, since the first process to open it receives a lock. If you intend\nto run the Admin and API on separate processes, you must call them with the\n'ponzu' command independently.", + "text": "Starts the HTTP server for the JSON API, Admin System, or both.\nThe segments, separated by a comma, describe which services to start, either \n'admin' (Admin System / CMS backend) or 'api' (JSON API), and, optionally, \nif the server should utilize TLS encryption - served over HTTPS, which is\nautomatically managed using Let's Encrypt (https://letsencrypt.org) Optional flags: --port sets the port on which the server listens for HTTP requests [defaults to 8080] --https-port sets the port on which the server listens for HTTPS requests [defaults to 443] --https enables auto HTTPS management via Let's Encrypt (port is always 443) --dev-https generates self-signed SSL certificates for development-only (port is 10443) --docs runs a local documentation server in case of no network connection --docs-port sets the port on which the docs server listens for HTTP requests [defaults to 1234] Example: $ ponzu run ( or ) \n$ ponzu run --port = 8080 --https admin,api ( or ) \n$ ponzu run admin ( or ) \n$ ponzu run --port = 8888 api ( or ) \n$ ponzu run --dev-https Defaults to $ ponzu run --port=8080 admin,api (running Admin API on port 8080, without TLS) Note: \nAdmin and API cannot run on separate processes unless you use a copy of the\ndatabase, since the first process to open it receives a lock. If you intend\nto run the Admin and API on separate processes, you must call them with the\n'ponzu' command independently.", "title": "run" }, { diff --git a/docs/build/sitemap.xml b/docs/build/sitemap.xml index b44409d..300b804 100644 --- a/docs/build/sitemap.xml +++ b/docs/build/sitemap.xml @@ -4,7 +4,7 @@ <url> <loc>/</loc> - <lastmod>2017-05-22</lastmod> + <lastmod>2017-06-10</lastmod> <changefreq>daily</changefreq> </url> @@ -13,13 +13,13 @@ <url> <loc>/CLI/General-Usage/</loc> - <lastmod>2017-05-22</lastmod> + <lastmod>2017-06-10</lastmod> <changefreq>daily</changefreq> </url> <url> <loc>/CLI/Generating-References/</loc> - <lastmod>2017-05-22</lastmod> + <lastmod>2017-06-10</lastmod> <changefreq>daily</changefreq> </url> @@ -29,13 +29,13 @@ <url> <loc>/Content/An-Overview/</loc> - <lastmod>2017-05-22</lastmod> + <lastmod>2017-06-10</lastmod> <changefreq>daily</changefreq> </url> <url> <loc>/Content/Extending-Content/</loc> - <lastmod>2017-05-22</lastmod> + <lastmod>2017-06-10</lastmod> <changefreq>daily</changefreq> </url> @@ -45,7 +45,7 @@ <url> <loc>/Form-Fields/HTML-Inputs/</loc> - <lastmod>2017-05-22</lastmod> + <lastmod>2017-06-10</lastmod> <changefreq>daily</changefreq> </url> @@ -55,19 +55,19 @@ <url> <loc>/HTTP-APIs/Content/</loc> - <lastmod>2017-05-22</lastmod> + <lastmod>2017-06-10</lastmod> <changefreq>daily</changefreq> </url> <url> <loc>/HTTP-APIs/File-Metadata/</loc> - <lastmod>2017-05-22</lastmod> + <lastmod>2017-06-10</lastmod> <changefreq>daily</changefreq> </url> <url> <loc>/HTTP-APIs/Search/</loc> - <lastmod>2017-05-22</lastmod> + <lastmod>2017-06-10</lastmod> <changefreq>daily</changefreq> </url> @@ -77,31 +77,31 @@ <url> <loc>/Interfaces/API/</loc> - <lastmod>2017-05-22</lastmod> + <lastmod>2017-06-10</lastmod> <changefreq>daily</changefreq> </url> <url> <loc>/Interfaces/Editor/</loc> - <lastmod>2017-05-22</lastmod> + <lastmod>2017-06-10</lastmod> <changefreq>daily</changefreq> </url> <url> <loc>/Interfaces/Format/</loc> - <lastmod>2017-05-22</lastmod> + <lastmod>2017-06-10</lastmod> <changefreq>daily</changefreq> </url> <url> <loc>/Interfaces/Item/</loc> - <lastmod>2017-05-22</lastmod> + <lastmod>2017-06-10</lastmod> <changefreq>daily</changefreq> </url> <url> <loc>/Interfaces/Search/</loc> - <lastmod>2017-05-22</lastmod> + <lastmod>2017-06-10</lastmod> <changefreq>daily</changefreq> </url> @@ -111,13 +111,13 @@ <url> <loc>/Ponzu-Addons/Creating-Addons/</loc> - <lastmod>2017-05-22</lastmod> + <lastmod>2017-06-10</lastmod> <changefreq>daily</changefreq> </url> <url> <loc>/Ponzu-Addons/Using-Addons/</loc> - <lastmod>2017-05-22</lastmod> + <lastmod>2017-06-10</lastmod> <changefreq>daily</changefreq> </url> @@ -127,7 +127,7 @@ <url> <loc>/Quickstart/Overview/</loc> - <lastmod>2017-05-22</lastmod> + <lastmod>2017-06-10</lastmod> <changefreq>daily</changefreq> </url> @@ -137,7 +137,7 @@ <url> <loc>/References/Overview/</loc> - <lastmod>2017-05-22</lastmod> + <lastmod>2017-06-10</lastmod> <changefreq>daily</changefreq> </url> @@ -147,7 +147,7 @@ <url> <loc>/Running-Backups/Backups/</loc> - <lastmod>2017-05-22</lastmod> + <lastmod>2017-06-10</lastmod> <changefreq>daily</changefreq> </url> @@ -157,7 +157,7 @@ <url> <loc>/System-Configuration/Settings/</loc> - <lastmod>2017-05-22</lastmod> + <lastmod>2017-06-10</lastmod> <changefreq>daily</changefreq> </url> @@ -167,13 +167,13 @@ <url> <loc>/System-Deployment/Docker/</loc> - <lastmod>2017-05-22</lastmod> + <lastmod>2017-06-10</lastmod> <changefreq>daily</changefreq> </url> <url> <loc>/System-Deployment/SysV-Style/</loc> - <lastmod>2017-05-22</lastmod> + <lastmod>2017-06-10</lastmod> <changefreq>daily</changefreq> </url> diff --git a/docs/src/CLI/General-Usage.md b/docs/src/CLI/General-Usage.md index 3a4544f..dbb8970 100644 --- a/docs/src/CLI/General-Usage.md +++ b/docs/src/CLI/General-Usage.md @@ -121,10 +121,13 @@ if the server should utilize TLS encryption - served over HTTPS, which is automatically managed using Let's Encrypt (https://letsencrypt.org) Optional flags: + - `--port` sets the port on which the server listens for HTTP requests [defaults to 8080] - `--https-port` sets the port on which the server listens for HTTPS requests [defaults to 443] - `--https` enables auto HTTPS management via Let's Encrypt (port is always 443) - `--dev-https` generates self-signed SSL certificates for development-only (port is 10443) +- `--docs` runs a local documentation server in case of no network connection +- `--docs-port` sets the port on which the docs server listens for HTTP requests [defaults to 1234] Example: ```bash @@ -136,7 +139,7 @@ $ ponzu run admin (or) $ ponzu run --port=8888 api (or) -$ ponzu --dev-https run +$ ponzu run --dev-https ``` Defaults to `$ ponzu run --port=8080 admin,api` (running Admin & API on port 8080, without TLS) |