Skip to content

Commit cd1cd01

Browse files
VitexusVitexus
committed
Add man page for csas-access-token and update service description
Add man page for csas-access-token and update service details Introduces a man page for the csas-access-token command, detailing its usage, options, and examples for better user guidance. Updates the csas-authorize service description to clarify its purpose as sending notifications for expiring CSAS access tokens. Adjusts the service to use a different execution command for improved functionality.
1 parent 72d9134 commit cd1cd01

3 files changed

Lines changed: 37 additions & 6 deletions

File tree

‎debian/csas-access-token.1‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
.TH csas-access-token 1 "June 2024" "csas-access-token"
2+
.SH NAME
3+
csas-access-token \- Manage and export CSAS access tokens
4+
.SH SYNOPSIS
5+
.B php csas-access-token
6+
[\fB--tokenId\fR=\fITOKEN_ID\fR] [\fB--output\fR=\fIOUTPUT_FILE\fR] [\fB--environment\fR=\fIENVIRONMENT\fR] [\fB--list\fR] [\fB--json\fR] [\fB--accesTokenKey\fR=\fIKEY\fR] [\fB--sandboxModeKey\fR=\fIKEY\fR]
7+
.SH DESCRIPTION
8+
The \fBcsas-access-token\fR command manages and exports CSAS access tokens.
9+
.SH OPTIONS
10+
.TP
11+
\fB--tokenId\fR, \fB-t\fR
12+
The token ID (required).
13+
.TP
14+
\fB--output\fR, \fB-o\fR
15+
The output file (optional).
16+
.TP
17+
\fB--environment\fR, \fB-e\fR
18+
The environment file with DB_* fields (optional).
19+
.TP
20+
\fB--list\fR, \fB-l\fR
21+
List available tokens (optional).
22+
.TP
23+
\fB--json\fR, \fB-j\fR
24+
Export token data in JSON format (optional).
25+
.TP
26+
\fB--accesTokenKey\fR, \fB-a\fR
27+
Specify custom Access Token key instead of CSAS_ACCESS_TOKEN.
28+
.TP
29+
\fB--sandboxModeKey\fR, \fB-s\fR
30+
Specify custom SandBox Mode key instead of CSAS_SANDBOX_MODE.
31+
.SH EXAMPLES
32+
.B csas-access-token -t71004963-e3d4-471f-96fc-1aef79d17ec1 -aCSAS_TOKEN -o.env
33+
.SH AUTHOR
34+
Vitex Software

‎debian/csas-authorize.service‎

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,12 @@
1-
#!/bin/sh
2-
# If this exists, it is installed into lib/systemd/system/csas-authorize.service in csas-authorize
3-
# See dh_systemd_enable(1).
4-
51
[Unit]
6-
Description=Run csas-authorize scheduled jobs
2+
Description=Send notification when CSAS access token is about to expire
73
After=multi-user.target
84

95
[Service]
106
User=csas-authorize
117
Group=csas-authorize
128
EnvironmentFile=/etc/csas-authorize/csas-authorize.env
13-
ExecStart=/usr/bin/php /usr/libexec/csas-authorize/daemon.php
9+
ExecStart=/usr/bin/csas-authorize
1410
LimitNOFILE=8192:16384
1511
Type=simple
1612

‎debian/manpages‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
debian/csas-access-token.1

0 commit comments

Comments
 (0)