status-ctl.1 1.37 KB
Newer Older
Dmytro Bogatov's avatar
Dmytro Bogatov committed
1 2 3 4 5 6
.de URL
\\$2 \(laURL: \\$1 \(ra\\$3
..
.if \n[.g] .mso www.tmac
.TH ...
.
Dmytro Bogatov's avatar
Dmytro Bogatov committed
7 8
.\" Manpage for status-ctl.
.\" Contact dmytro@dbogatov.org to correct errors or typos.
Dmytro Bogatov's avatar
Fix.  
Dmytro Bogatov committed
9
.TH man 1 "4 August 2017" "1.2.0" "status-ctl man page"
Dmytro Bogatov's avatar
Dmytro Bogatov committed
10
.SH NAME
Dmytro Bogatov's avatar
Dmytro Bogatov committed
11 12
.B status-ctl 
\- control tool for status site
Dmytro Bogatov's avatar
Dmytro Bogatov committed
13
.SH SYNOPSIS
Dmytro Bogatov's avatar
Dmytro Bogatov committed
14
.B status-ctl 
Dmytro Bogatov's avatar
Dmytro Bogatov committed
15
[ \fIOPTIONS\fR ]
Dmytro Bogatov's avatar
Dmytro Bogatov committed
16
\fICOMMAND\fR
Dmytro Bogatov's avatar
Dmytro Bogatov committed
17
.SH DESCRIPTION
Dmytro Bogatov's avatar
Dmytro Bogatov committed
18
The \fBstatus-ctl\fR is a tool to control status site. It lets user easily start, stop, reconfigure and update the status site app. Status site itself is a docker composition, and \fBstatus-ctl\fR is merely a bash wrapper around docker-compose. For the docs on status site itself, please see
Dmytro Bogatov's avatar
Fix.  
Dmytro Bogatov committed
19
.URL "https://status.dbogatov.org/docs/" "Status Site docs" .
Dmytro Bogatov's avatar
Dmytro Bogatov committed
20 21 22 23 24
.SH OPTIONS
For a list of command-line options, run
.PP
.nf
.RS
Dmytro Bogatov's avatar
Dmytro Bogatov committed
25
status-ctl help
Dmytro Bogatov's avatar
Dmytro Bogatov committed
26 27 28 29
.RE
.fi
.PP
.SH EXAMPLES
Dmytro Bogatov's avatar
Dmytro Bogatov committed
30
The following command will deploy status site from dev branch preserving the database:
Dmytro Bogatov's avatar
Dmytro Bogatov committed
31 32 33
.PP
.nf
.RS
Dmytro Bogatov's avatar
Dmytro Bogatov committed
34 35 36 37 38 39 40 41 42
status-ctl -b dev upgrade
.RE
.fi
.PP
The following command will deploy status site from master branch recreating the database:
.PP
.nf
.RS
status-ctl upgrade-clean
Dmytro Bogatov's avatar
Dmytro Bogatov committed
43 44 45 46
.RE
.fi
.PP
.SH BUGS
Dmytro Bogatov's avatar
Fix.  
Dmytro Bogatov committed
47
Bug tracking is performed using
Dmytro Bogatov's avatar
Hotfix.  
Dmytro Bogatov committed
48
.URL "https://github.com/dbogatov/status-site/issues" "GitHub issues" .
Dmytro Bogatov's avatar
Dmytro Bogatov committed
49
.SH COPYRIGHT
Dmytro Bogatov's avatar
Dmytro Bogatov committed
50
(C) Dmytro Bogatov 2017. Licensed under the terms of MIT.
Dmytro Bogatov's avatar
Dmytro Bogatov committed
51
.SH "SEE ALSO"
Dmytro Bogatov's avatar
Fix.  
Dmytro Bogatov committed
52
.URL "https://status.dbogatov.org" "Status site demo" .
Dmytro Bogatov's avatar
Hotfix.  
Dmytro Bogatov committed
53
.PP
Dmytro Bogatov's avatar
Fix.  
Dmytro Bogatov committed
54
.URL "https://status.dbogatov.org/docs/" "Status site docs" .