You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Apr 26, 2024. It is now read-only.
\fBhash_password\fR calculates the hash of a supplied password using bcrypt\.
14
-
.
15
10
.P
16
11
\fBhash_password\fR takes a password as an parameter either on the command line or the \fBSTDIN\fR if not supplied\.
17
-
.
18
12
.P
19
13
It accepts an YAML file which can be used to specify parameters like the number of rounds for bcrypt and password_config section having the pepper value used for the hashing\. By default \fBbcrypt_rounds\fR is set to \fB10\fR\.
20
-
.
21
14
.P
22
15
The hashed password is written on the \fBSTDOUT\fR\.
23
-
.
24
16
.SH "FILES"
25
17
A sample YAML file accepted by \fBhash_password\fR is described below:
Read the password form the command line if [password] is supplied\. If not, prompt the user and read the password form the \fBSTDIN\fR\. It is not recommended to type the password on the command line directly\. Use the STDIN instead\.
35
-
.
36
24
.TP
37
25
\fB\-c\fR, \fB\-\-config\fR
38
26
Read the supplied YAML \fIfile\fR containing the options \fBbcrypt_rounds\fR and the \fBpassword_config\fR section containing the \fBpepper\fR value\.
\fBregister_new_matrix_user\fR registers new users with a given home server when registration has been disabled\. For this to work, the home server must be configured with the \'registration_shared_secret\' option set\.
14
-
.
15
10
.P
16
11
This accepts the user credentials like the username, password, is user an admin or not and registers the user onto the homeserver database\. Also, a YAML file containing the shared secret can be provided\. If not, the shared secret can be provided via the command line\.
17
-
.
18
12
.P
19
13
By default it assumes the home server URL to be \fBhttps://localhost:8448\fR\. This can be changed via the \fBserver_url\fR command line option\.
20
-
.
21
14
.SH "FILES"
22
15
A sample YAML file accepted by \fBregister_new_matrix_user\fR is described below:
23
-
.
24
16
.IP""4
25
-
.
26
17
.nf
27
-
28
18
registration_shared_secret: "s3cr3t"
29
-
.
30
19
.fi
31
-
.
32
20
.IP""0
33
-
.
34
21
.SH "OPTIONS"
35
-
.
36
22
.TP
37
23
\fB\-u\fR, \fB\-\-user\fR
38
24
Local part of the new user\. Will prompt if omitted\.
39
-
.
40
25
.TP
41
26
\fB\-p\fR, \fB\-\-password\fR
42
27
New password for user\. Will prompt if omitted\. Supplying the password on the command line is not recommended\. Use the STDIN instead\.
43
-
.
44
28
.TP
45
29
\fB\-a\fR, \fB\-\-admin\fR
46
30
Register new user as an admin\. Will prompt if omitted\.
47
-
.
48
31
.TP
49
32
\fB\-c\fR, \fB\-\-config\fR
50
33
Path to server config file containing the shared secret\.
51
-
.
52
34
.TP
53
35
\fB\-k\fR, \fB\-\-shared\-secret\fR
54
36
Shared secret as defined in server config file\. This is an optional parameter as it can be also supplied via the YAML file\.
55
-
.
56
37
.TP
57
38
\fBserver_url\fR
58
39
URL of the home server\. Defaults to \'https://localhost:8448\'\.
\fBsynapse_port_db\fR ports an existing synapse SQLite database to a new PostgreSQL database\.
14
-
.
15
10
.P
16
11
SQLite database is specified with \fB\-\-sqlite\-database\fR option and PostgreSQL configuration required to connect to PostgreSQL database is provided using \fB\-\-postgres\-config\fR configuration\. The configuration is specified in YAML format\.
17
-
.
18
12
.SH "OPTIONS"
19
-
.
20
13
.TP
21
14
\fB\-v\fR
22
15
Print log messages in \fBdebug\fR level instead of \fBinfo\fR level\.
23
-
.
24
16
.TP
25
17
\fB\-\-sqlite\-database\fR
26
18
The snapshot of the SQLite database file\. This must not be currently used by a running synapse server\.
27
-
.
28
19
.TP
29
20
\fB\-\-postgres\-config\fR
30
21
The database config file for the PostgreSQL database\.
31
-
.
32
22
.TP
33
23
\fB\-\-curses\fR
34
24
Display a curses based progress UI\.
35
-
.
36
25
.SH "CONFIG FILE"
37
26
The postgres configuration file must be a valid YAML file with the following options\.
38
-
.
39
-
.IP"\(bu"4
27
+
.IP"\[ci]"4
40
28
\fBdatabase\fR: Database configuration section\. This section header can be ignored and the options below may be specified as top level keys\.
41
-
.
42
-
.IP"\(bu"4
29
+
.IP"\[ci]"4
43
30
\fBname\fR: Connector to use when connecting to the database\. This value must be \fBpsycopg2\fR\.
44
-
.
45
-
.IP"\(bu"4
31
+
.IP"\[ci]"4
46
32
\fBargs\fR: DB API 2\.0 compatible arguments to send to the \fBpsycopg2\fR module\.
47
-
.
48
-
.IP"\(bu"4
33
+
.IP"\[ci]"4
49
34
\fBdbname\fR\- the database name
50
-
.
51
-
.IP"\(bu"4
35
+
.IP"\[ci]"4
52
36
\fBuser\fR\- user name used to authenticate
53
-
.
54
-
.IP"\(bu"4
37
+
.IP"\[ci]"4
55
38
\fBpassword\fR\- password used to authenticate
56
-
.
57
-
.IP"\(bu"4
39
+
.IP"\[ci]"4
58
40
\fBhost\fR\- database host address (defaults to UNIX socket if not provided)
59
-
.
60
-
.IP"\(bu"4
41
+
.IP"\[ci]"4
61
42
\fBport\fR\- connection port number (defaults to 5432 if not provided)
62
-
.
63
43
.IP""0
64
44
65
-
.
66
-
.IP"\(bu"4
45
+
.IP"\[ci]"4
67
46
\fBsynchronous_commit\fR: Optional\. Default is True\. If the value is \fBFalse\fR, enable asynchronous commit and don\'t wait for the server to call fsync before ending the transaction\. See: https://www\.postgresql\.org/docs/current/static/wal\-async\-commit\.html
68
-
.
69
47
.IP""0
70
48
71
-
.
72
49
.IP""0
73
-
.
74
50
.P
75
51
Following example illustrates the configuration file format\.
76
-
.
77
52
.IP""4
78
-
.
79
53
.nf
80
-
81
54
database:
82
55
name: psycopg2
83
56
args:
@@ -86,13 +59,9 @@ database:
86
59
password: ORohmi9Eet=ohphi
87
60
host: localhost
88
61
synchronous_commit: false
89
-
.
90
62
.fi
91
-
.
92
63
.IP""0
93
-
.
94
64
.SH "COPYRIGHT"
95
-
This man page was written by Sunil Mohan Adapa <\fIsunil@medhas\.org\fR> for Debian GNU/Linux distribution\.
96
-
.
65
+
This man page was written by Sunil Mohan Adapa <\fI\%mailto:sunil@medhas\.org\fR> for Debian GNU/Linux distribution\.
0 commit comments