-
Notifications
You must be signed in to change notification settings - Fork 17
/
elabctl.1
118 lines (117 loc) · 2.07 KB
/
elabctl.1
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
.\" Manpage for elabctl.
.TH ELABCTL 1
.SH NAME
elabctl \- manage an eLabFTW installation
.SH SYNOPSIS
.B elabctl \fI[OPTION] \fI[COMMAND]
.TP
.B elabctl \fI--help
.TP
.B elabctl \fIbackup
.SH DESCRIPTION
.B elabctl
allows you to install, backup, monitor and update easily eLabFTW.
.SH OPTIONS
.PP
The following options are understood:
.PP
\fB\-h\fR, \fB\-\-help\fR
.RS 4
Display usage summary
.RE
.PP
\fB\-v\fR, \fB\-\-version\fR
.RS 4
Display current version
.SH COMMANDS
.PP
The following commands are understood:
.PP
.BR backup
.RS 4
Make a backup of your installation in /var/backups/elabftw
.RE
.TP
.BR bugreport
.RS 4
Gather informations about the system to help when creating a new issue/bug report
.RE
.TP
.BR help
.RS 4
Display available commands
.RE
.TP
.BR info
.RS 4
Display the configured variables and show the status
.RE
.TP
.BR install
.RS 4
Configure eLabFTW interactively. It will install Pip, a python package manager,
used to install docker-compose. It will also prepare the docker-compose
configuration file /etc/elabftw.yml and get the TLS certificates from
Let's Encrypt if possible.
.RE
.TP
.BR logs
.RS 4
Show logs of the mysql and eLabFTW containers
.RE
.TP
.BR php-logs
.RS 4
Show the last 15 lines of /var/log/nginx/error.log from the container
.RE
.TP
.BR refresh
.RS 4
Restart the containers if they need to be refreshed. Do nothing if they are up to date
.RE
.TP
.BR restart
.RS 4
Restart the containers
.RE
.TP
.BR self-update
.RS 4
Fetch the latest version of the
.B elabctl
script and save it in /usr/bin.
.RE
.TP
.BR start
.RS 4
Start the containers
.RE
.TP
.BR status
.RS 4
Show status of running containers
.RE
.TP
.BR stop
.RS 4
Stop the containers
.RE
.TP
.BR uninstall
.RS 4
Remove all trace of eLabFTW on this system. Will delete the containers, the images, the config file, the man page, the data directory, the backup directory and the log file.
.RE
.TP
.BR update
.RS 4
Update to the latest version
.RE
.TP
.BR version
.RS 4
Display current version
.RE
.SH BUGS
No known bugs. But if you find one, make sure to tell me!
.SH AUTHOR
Nicolas CARPi ([email protected])