Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update CLI FAQ to support Proxy components #1608

Draft
wants to merge 273 commits into
base: dev
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
273 commits
Select commit Hold shift + click to select a range
7e5871e
Merge pull request #894 from wso2/dev
shaniR May 10, 2023
9ea2c15
Merge pull request #896 from wso2/dev
ruthryi May 11, 2023
099d09f
Merge pull request #898 from wso2/dev
Nashaath May 11, 2023
2d99128
Merge pull request #900 from wso2/dev
ruthryi May 11, 2023
8f4d444
Merge pull request #902 from wso2/dev
shaniR May 12, 2023
02ebbee
Merge pull request #904 from wso2/dev
Nashaath May 12, 2023
76dffa3
Merge pull request #905 from wso2/dev
shaniR May 15, 2023
1d267d2
Merge pull request #911 from wso2/dev
shaniR May 17, 2023
b50ce28
Merge pull request #914 from wso2/dev
Nashaath May 17, 2023
feb0940
Merge pull request #915 from wso2/dev
shaniR May 19, 2023
ab6dced
Merge pull request #922 from wso2/dev
shaniR Jun 5, 2023
3c66bd1
Merge pull request #927 from wso2/dev
shaniR Jun 5, 2023
5d1d696
Merge pull request #929 from wso2/dev
shaniR Jun 5, 2023
a4b00ae
Merge pull request #931 from wso2/dev
shaniR Jun 5, 2023
3ffedd3
Merge pull request #933 from wso2/dev
shaniR Jun 6, 2023
5834713
Merge pull request #935 from wso2/dev
Nashaath Jun 8, 2023
8e72d17
Merge pull request #937 from wso2/dev
Nashaath Jun 8, 2023
83b0cc0
Merge pull request #939 from wso2/dev
Nashaath Jun 9, 2023
166051f
Merge pull request #941 from wso2/dev
shaniR Jun 12, 2023
773a3c3
Merge pull request #944 from wso2/dev
shaniR Jun 13, 2023
9acdc87
Merge pull request #949 from wso2/dev
shaniR Jun 14, 2023
7c879e0
Merge pull request #952 from wso2/dev
Nashaath Jun 15, 2023
9d62286
Merge pull request #959 from wso2/dev
Nashaath Jun 19, 2023
b03514c
Merge pull request #961 from wso2/dev
Nashaath Jun 19, 2023
e951d43
Merge pull request #963 from wso2/dev
Nashaath Jun 20, 2023
f4293c8
Merge pull request #970 from wso2/dev
Nashaath Jun 27, 2023
86a1c96
Merge pull request #978 from wso2/dev
shaniR Jun 28, 2023
1960fb5
Merge pull request #980 from wso2/dev
shaniR Jun 28, 2023
24ded91
Merge pull request #985 from wso2/dev
Nashaath Jul 5, 2023
a198d7a
Merge pull request #987 from wso2/dev
chamindi-a Jul 5, 2023
196783c
Merge pull request #990 from wso2/dev
shaniR Jul 7, 2023
0de9306
Merge pull request #992 from wso2/dev
Nashaath Jul 10, 2023
64375f2
Merge pull request #995 from wso2/dev
Nashaath Jul 12, 2023
d54e3e7
Merge pull request #996 from wso2/dev
shaniR Jul 12, 2023
51c97bb
Merge pull request #998 from wso2/dev
shaniR Jul 12, 2023
6042fb4
Merge pull request #1000 from wso2/dev
shaniR Jul 12, 2023
a361281
Merge pull request #1002 from wso2/dev
shaniR Jul 14, 2023
6260923
Merge pull request #1005 from wso2/dev
shaniR Jul 17, 2023
1ac1692
Merge pull request #1007 from wso2/dev
Nashaath Jul 18, 2023
1f3529d
Merge pull request #1009 from wso2/dev
Nashaath Jul 20, 2023
6430a76
Merge pull request #1011 from wso2/dev
chamindi-a Jul 20, 2023
9e29339
Merge pull request #1014 from wso2/dev
Nashaath Jul 24, 2023
be757ee
Merge pull request #1018 from wso2/dev
shaniR Jul 25, 2023
8a296f7
Merge pull request #1020 from wso2/dev
shaniR Jul 26, 2023
1d1d5ed
Merge pull request #1023 from wso2/dev
shaniR Jul 27, 2023
6e84a24
Merge pull request #1026 from wso2/dev
shaniR Jul 27, 2023
036fbb7
Merge pull request #1028 from wso2/dev
chamindi-a Jul 28, 2023
be93d21
Merge pull request #1029 from wso2/dev
shaniR Jul 31, 2023
9166b95
Merge pull request #1032 from wso2/dev
shaniR Jul 31, 2023
adf81b3
Merge pull request #1036 from wso2/dev
Nashaath Aug 7, 2023
9483f4d
Merge pull request #1039 from wso2/dev
chamindi-a Aug 10, 2023
7d8ad59
Merge pull request #1044 from wso2/dev
shaniR Aug 16, 2023
7b98712
Merge pull request #1048 from wso2/dev
shaniR Aug 17, 2023
5192625
Merge pull request #1050 from wso2/dev
shaniR Aug 17, 2023
8dc9127
Merge pull request #1052 from wso2/dev
shaniR Aug 17, 2023
6645017
Merge pull request #1054 from wso2/dev
shaniR Aug 17, 2023
6e9d3d0
Merge pull request #1056 from wso2/dev
shaniR Aug 18, 2023
9fbfdb1
Merge pull request #1058 from wso2/dev
shaniR Aug 18, 2023
8d5e74d
Merge pull request #1060 from wso2/dev
shaniR Aug 18, 2023
c73d9bd
Merge pull request #1062 from wso2/dev
shaniR Aug 18, 2023
7fe82ed
Merge pull request #1065 from wso2/dev
shaniR Aug 18, 2023
33a42af
Merge pull request #1067 from wso2/dev
Nashaath Aug 18, 2023
4aa048b
Merge pull request #1069 from wso2/dev
shaniR Aug 23, 2023
f1570cc
Merge pull request #1072 from wso2/dev
Nashaath Aug 25, 2023
ee4c4a6
Merge pull request #1075 from wso2/dev
Nashaath Aug 25, 2023
86464f5
Merge pull request #1076 from wso2/dev
shaniR Aug 28, 2023
8557e46
Merge pull request #1078 from wso2/dev
shaniR Aug 29, 2023
9846a03
Merge pull request #1082 from wso2/dev
Nashaath Aug 29, 2023
fc8a78b
Merge pull request #1093 from wso2/dev
shaniR Sep 6, 2023
652dd72
Merge pull request #1097 from wso2/dev
shaniR Sep 9, 2023
de0cd24
Merge pull request #1099 from wso2/dev
shaniR Sep 11, 2023
ad70d86
Merge pull request #1101 from wso2/dev
chamindi-a Sep 11, 2023
65a076c
Merge pull request #1105 from wso2/dev
shaniR Sep 15, 2023
32406b9
Merge pull request #1110 from wso2/dev
Nashaath Sep 15, 2023
70d9c60
Merge pull request #1113 from wso2/dev
shaniR Sep 18, 2023
3e68ac2
Merge pull request #1117 from wso2/dev
shaniR Sep 19, 2023
48b7836
Merge pull request #1120 from wso2/dev
shaniR Sep 19, 2023
4bf6985
Merge pull request #1123 from wso2/dev
shaniR Sep 19, 2023
5006dba
Merge pull request #1126 from wso2/dev
shaniR Sep 20, 2023
18556ac
Merge pull request #1129 from wso2/dev
shaniR Sep 21, 2023
3f930fa
Merge pull request #1131 from wso2/dev
shaniR Sep 27, 2023
8654646
Merge pull request #1133 from wso2/dev
shaniR Sep 27, 2023
7521cec
Merge pull request #1135 from wso2/dev
Nashaath Oct 2, 2023
0a30053
Merge pull request #1139 from wso2/dev
shaniR Oct 4, 2023
1913a5e
Create pipeline yaml to upload doc site content to storage account
udhanMti Oct 6, 2023
643052b
Update pip package versions
udhanMti Oct 6, 2023
bead65b
Merge pull request #1142 from wso2/dev
shaniR Oct 6, 2023
a59e599
Merge pull request #1144 from wso2/dev
shaniR Oct 6, 2023
8e4674f
Merge pull request #1147 from wso2/dev
Nashaath Oct 9, 2023
2c447d5
Update the pipeline yaml to match with the build steps in Jenkins
udhanMti Oct 9, 2023
7b57f1e
Merge pull request #1140 from udhanMti/main-10-06
shaniR Oct 9, 2023
6402397
Update the storage account name in prod deploy pipeline
udhanMti Oct 10, 2023
a999ab0
Merge pull request #1151 from wso2/dev
shaniR Oct 11, 2023
e02b690
Merge pull request #1148 from udhanMti/main-10-10
shaniR Oct 17, 2023
1ff3185
Merge pull request #1154 from wso2/dev
shaniR Oct 17, 2023
fa535fb
Merge pull request #1161 from wso2/dev
shaniR Oct 20, 2023
b74fc4c
Update the storage account name
udhanMti Oct 23, 2023
b47b94f
Merge pull request #1163 from udhanMti/main-10-23
Nashaath Oct 23, 2023
6344abe
Merge pull request #1166 from wso2/dev
Nashaath Oct 27, 2023
e8d1d74
Merge pull request #1168 from wso2/dev
Nashaath Oct 27, 2023
bcaae4a
Merge pull request #1198 from wso2/dev
Nashaath Nov 1, 2023
c324211
Merge pull request #1200 from wso2/dev
Nashaath Nov 1, 2023
b1f11bd
Merge pull request #1202 from wso2/dev
shaniR Nov 2, 2023
d4bc8db
Merge pull request #1208 from wso2/dev
shaniR Nov 9, 2023
ea9ee51
Merge pull request #1210 from wso2/dev
Nashaath Nov 10, 2023
32fe261
Merge pull request #1214 from wso2/dev
shaniR Nov 15, 2023
3aa8973
Change content path in storage acc to /choreo/docs
udhanMti Nov 17, 2023
3f028ec
Merge pull request #1219 from wso2/dev
shaniR Nov 17, 2023
9160a3b
Merge pull request #1217 from udhanMti/main-11-17
shaniR Nov 20, 2023
fec7e04
Replace delete/upload with sync
udhanMti Nov 20, 2023
9884386
Merge pull request #1224 from udhanMti/main-11-20
shaniR Nov 20, 2023
d1f9510
Merge pull request #1228 from wso2/dev
Nashaath Nov 22, 2023
3564d11
Merge pull request #1233 from wso2/dev
Nashaath Nov 28, 2023
cbe3adf
Merge pull request #1235 from wso2/dev
Nashaath Nov 28, 2023
e080428
Merge pull request #1264 from wso2/dev
shaniR Dec 14, 2023
536a646
Merge pull request #1268 from wso2/dev
shaniR Dec 14, 2023
b79d6d8
Merge pull request #1270 from wso2/dev
shaniR Dec 22, 2023
c471ac0
Merge pull request #1272 from wso2/dev
Nashaath Dec 22, 2023
79cf2b3
Merge pull request #1275 from wso2/dev
shaniR Jan 3, 2024
f31ed83
Merge pull request #1278 from wso2/dev
Nashaath Jan 8, 2024
290861a
Merge pull request #1280 from wso2/dev
shaniR Jan 8, 2024
431eeb4
Merge pull request #1282 from wso2/dev
Nashaath Jan 8, 2024
6248f14
Merge pull request #1286 from wso2/dev
shaniR Jan 10, 2024
1e0dc82
Merge pull request #1288 from wso2/dev
Nashaath Jan 10, 2024
394e527
Merge pull request #1289 from wso2/dev
Nashaath Jan 11, 2024
a8d194e
Merge pull request #1297 from wso2/dev
Nashaath Jan 19, 2024
66b4e1f
Merge pull request #1299 from wso2/dev
Nashaath Jan 22, 2024
68bf9a9
Merge pull request #1301 from wso2/dev
Nashaath Jan 23, 2024
381e117
Merge pull request #1304 from wso2/dev
shaniR Jan 30, 2024
4056b5a
Merge pull request #1308 from wso2/dev
shaniR Jan 31, 2024
5219fac
Merge pull request #1315 from wso2/dev
shaniR Feb 6, 2024
2ed8b28
Merge pull request #1319 from wso2/dev
Nashaath Feb 8, 2024
0c68778
Merge pull request #1325 from wso2/dev
Nashaath Feb 9, 2024
8e2e456
Merge pull request #1327 from wso2/dev
shaniR Feb 10, 2024
a8d30af
Merge pull request #1331 from wso2/dev
shaniR Feb 12, 2024
4db9f0a
Merge pull request #1334 from wso2/dev
Nashaath Feb 12, 2024
91e3103
Update prod-build.yaml
shaniR Feb 12, 2024
c5f5c07
Merge pull request #1335 from wso2/shaniR-patch-3
Nashaath Feb 12, 2024
3f41e1e
Merge pull request #1337 from wso2/dev
shaniR Feb 12, 2024
bf508b2
Merge pull request #1339 from wso2/dev
Nashaath Feb 12, 2024
53b396b
Merge pull request #1341 from wso2/dev
Nashaath Feb 13, 2024
159584d
Merge pull request #1345 from wso2/dev
Nashaath Feb 16, 2024
5c4bee8
Merge pull request #1347 from wso2/dev
Nashaath Feb 16, 2024
760e8af
Merge pull request #1349 from wso2/dev
shaniR Feb 16, 2024
b58e564
Merge pull request #1351 from wso2/dev
shaniR Feb 19, 2024
bb0173c
Merge pull request #1359 from wso2/dev
shaniR Feb 23, 2024
906288e
Merge pull request #1360 from wso2/dev
Nashaath Feb 27, 2024
46e36e6
Merge pull request #1364 from wso2/dev
shaniR Feb 28, 2024
7529dc9
Merge pull request #1366 from wso2/dev
shaniR Feb 29, 2024
4f96bca
Merge pull request #1368 from wso2/dev
shaniR Mar 1, 2024
015312f
Merge pull request #1370 from wso2/dev
shaniR Mar 4, 2024
83f2512
Merge pull request #1372 from wso2/dev
Nashaath Mar 5, 2024
bcf03ed
Merge pull request #1375 from wso2/dev
chathuranga95 Mar 6, 2024
054671b
Merge pull request #1377 from wso2/dev
Nashaath Mar 6, 2024
dc30e41
Merge pull request #1378 from wso2/dev
shaniR Mar 6, 2024
a9eff22
Merge pull request #1384 from wso2/dev
shaniR Mar 13, 2024
c2e5296
Merge pull request #1386 from wso2/dev
shaniR Mar 13, 2024
18c48fa
Merge pull request #1389 from wso2/dev
Nashaath Mar 14, 2024
e857e64
Merge pull request #1400 from wso2/dev
shaniR Mar 19, 2024
efd35cf
Merge pull request #1403 from wso2/dev
shaniR Mar 20, 2024
a302726
Merge pull request #1407 from wso2/dev
Nashaath Mar 22, 2024
78e1fdf
Merge pull request #1409 from wso2/dev
Nashaath Mar 22, 2024
ea34588
Remove old prod build pipeline yaml
udhanMti Mar 22, 2024
752ad3c
Merge pull request #1411 from udhanMti/main-03-22
shaniR Mar 22, 2024
4b50d49
Merge pull request #1413 from wso2/dev
shaniR Mar 26, 2024
4964890
Merge pull request #1415 from wso2/dev
Nashaath Mar 27, 2024
0fc287c
Merge pull request #1417 from wso2/dev
shaniR Mar 28, 2024
d453950
Merge pull request #1422 from wso2/dev
Nashaath Apr 3, 2024
b73dc74
Merge pull request #1424 from wso2/dev
Nashaath Apr 5, 2024
bb2d91c
Merge pull request #1428 from wso2/dev
shaniR Apr 17, 2024
a83d198
Merge pull request #1432 from wso2/dev
Nashaath Apr 22, 2024
9599f73
Merge pull request #1436 from wso2/dev
Nashaath Apr 26, 2024
3e7ae01
Merge pull request #1438 from wso2/dev
Nashaath Apr 29, 2024
ad18163
Merge pull request #1439 from wso2/dev
Nashaath Apr 29, 2024
57dcf2f
Merge pull request #1443 from wso2/dev
Nashaath May 1, 2024
ccea0aa
Merge pull request #1445 from wso2/dev
Nashaath May 2, 2024
e78e196
Merge pull request #1448 from wso2/dev
Nashaath May 3, 2024
e1b6c08
Merge pull request #1450 from wso2/dev
Nashaath May 4, 2024
c9a8750
Merge pull request #1457 from wso2/dev
Nashaath May 7, 2024
4ec3117
Merge pull request #1458 from wso2/dev
Nashaath May 9, 2024
0629e4b
Merge pull request #1462 from wso2/dev
Nashaath May 13, 2024
2a30d9a
Merge pull request #1464 from wso2/dev
Nashaath May 14, 2024
7009dcc
Merge pull request #1466 from wso2/dev
vlgunarathne May 15, 2024
8f14c57
Merge pull request #1468 from wso2/dev
Nashaath May 16, 2024
6cab79f
Merge pull request #1473 from wso2/dev
Nashaath May 17, 2024
c2199b5
Merge pull request #1474 from wso2/dev
Nashaath May 21, 2024
45e4266
Merge pull request #1480 from wso2/dev
Nashaath May 21, 2024
7f9adef
Merge pull request #1481 from wso2/dev
Nashaath May 22, 2024
d4956a0
Merge pull request #1483 from wso2/dev
Nashaath May 22, 2024
60b7436
Merge pull request #1486 from wso2/dev
Nashaath May 27, 2024
0cf31fb
Merge pull request #1487 from wso2/dev
Nashaath May 28, 2024
5b4d239
Merge pull request #1489 from wso2/dev
Nashaath May 29, 2024
9e9cfc9
Merge pull request #1492 from wso2/dev
Nashaath Jun 4, 2024
3477902
Merge pull request #1494 from wso2/dev
Nashaath Jun 10, 2024
75cf690
Merge pull request #1497 from wso2/dev
Nashaath Jun 11, 2024
094e2c3
Merge pull request #1498 from wso2/dev
Nashaath Jun 11, 2024
222b333
Merge pull request #1501 from wso2/dev
Nashaath Jun 12, 2024
676be8b
Merge pull request #1502 from wso2/dev
Nashaath Jun 12, 2024
9f92b83
Merge pull request #1503 from wso2/dev
Nashaath Jun 13, 2024
952374a
Merge pull request #1504 from wso2/dev
Nashaath Jun 13, 2024
77635b7
Merge pull request #1510 from wso2/dev
Nashaath Jun 14, 2024
e89e457
Merge pull request #1511 from wso2/dev
Nashaath Jun 19, 2024
e86a4db
Merge pull request #1513 from wso2/dev
Nashaath Jun 24, 2024
4912eec
Merge pull request #1515 from wso2/dev
Nashaath Jun 24, 2024
87e2657
Merge pull request #1518 from wso2/dev
Nashaath Jul 2, 2024
369947b
Merge pull request #1522 from wso2/dev
Nashaath Jul 4, 2024
005e95b
Merge pull request #1523 from wso2/dev
Nashaath Jul 5, 2024
599387a
Merge pull request #1525 from wso2/dev
Nashaath Jul 9, 2024
7516cbf
Merge pull request #1527 from wso2/dev
Nashaath Jul 12, 2024
cf842a0
Merge pull request #1530 from wso2/dev
Nashaath Jul 19, 2024
d12ec7b
Merge pull request #1532 from wso2/dev
Nashaath Jul 22, 2024
2c6b8c5
Merge pull request #1533 from wso2/dev
Nashaath Jul 23, 2024
62f3743
Merge pull request #1535 from wso2/dev
Nashaath Jul 25, 2024
b901d3b
Merge pull request #1537 from wso2/dev
Nashaath Jul 31, 2024
8013e4b
Merge pull request #1541 from wso2/dev
Nashaath Aug 5, 2024
2473a41
Merge pull request #1544 from wso2/dev
Nashaath Aug 8, 2024
68bf2fa
Merge pull request #1547 from wso2/dev
Nashaath Aug 15, 2024
7e133b2
Merge pull request #1551 from wso2/dev
Nashaath Aug 20, 2024
c1f0ec2
Merge pull request #1554 from wso2/dev
Nashaath Aug 22, 2024
87c90f1
Merge pull request #1556 from wso2/dev
Nashaath Aug 23, 2024
5bb029d
Merge pull request #1559 from wso2/dev
Nashaath Aug 27, 2024
1431775
Merge pull request #1561 from wso2/dev
Nashaath Aug 29, 2024
72e3fe2
Merge pull request #1563 from wso2/dev
Nashaath Sep 5, 2024
431278e
Merge pull request #1564 from wso2/dev
Nashaath Sep 9, 2024
f10755d
Merge pull request #1570 from wso2/dev
Nashaath Sep 17, 2024
cbf57bf
Merge pull request #1572 from wso2/dev
Nashaath Sep 19, 2024
7e0aa96
Merge pull request #1574 from wso2/dev
Nashaath Sep 19, 2024
698c4ad
Merge pull request #1577 from wso2/dev
Nashaath Sep 23, 2024
7a8564a
Merge pull request #1581 from wso2/dev
Nashaath Sep 26, 2024
f905eb9
Merge pull request #1593 from wso2/dev
Nashaath Oct 8, 2024
adaba6a
Merge pull request #1601 from wso2/dev
Nashaath Oct 11, 2024
44f61ca
Merge pull request #1607 from wso2/dev
Nashaath Oct 16, 2024
f7bb4aa
Update docs to support API proxy
CharukaK Oct 20, 2024
ad9f84e
Merge branch 'cli-faq' of https://github.com/CharukaK/docs-choreo-dev…
CharukaK Oct 20, 2024
6052f57
Merge pull request #1611 from wso2/dev
Nashaath Oct 21, 2024
84a11eb
Merge pull request #1612 from wso2/dev
Nashaath Oct 22, 2024
3dc0b17
Merge pull request #1614 from wso2/dev
Nashaath Oct 22, 2024
e3832fe
Merge pull request #1616 from wso2/dev
Nashaath Oct 22, 2024
23f110e
Merge pull request #1621 from wso2/dev
Nashaath Oct 24, 2024
1387be3
Merge pull request #1627 from wso2/dev
Nashaath Oct 29, 2024
e635bc7
Merge pull request #1631 from wso2/dev
sumuduliyanage Oct 31, 2024
700c25b
Merge pull request #1632 from wso2/dev
Nashaath Oct 31, 2024
350c4ea
Merge pull request #1633 from wso2/dev
Nashaath Nov 1, 2024
1e6d016
Merge pull request #1640 from wso2/dev
Nashaath Nov 4, 2024
f4aa69e
Merge pull request #1643 from wso2/dev
Nashaath Nov 4, 2024
8303181
Merge pull request #1646 from wso2/dev
Nashaath Nov 5, 2024
e7a271b
Merge pull request #1651 from wso2/dev
LakshanSS Nov 6, 2024
92fb60b
Merge pull request #1652 from wso2/dev
Nashaath Nov 6, 2024
a38015d
Merge branch 'main' of https://github.com/wso2/docs-choreo-dev into c…
CharukaK Nov 7, 2024
5ac2633
Add Personal Access Token documentation guide
CharukaK Nov 7, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
98 changes: 98 additions & 0 deletions en/docs/choreo-cli/using-personal-access-tokens.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
# Personal Access Tokens Guide for Choreo CLI

## Introduction
Personal Access Tokens (PATs) allow you to authenticate without using your primary credentials, adding an extra layer of security and ease of management.

---

## Table of Contents

1. [What Are Personal Access Tokens?](#what-are-personal-access-tokens)
2. [Setting Up Personal Access Tokens](#setting-up-personal-access-tokens)
3. [Using Personal Access Tokens with Choreo CLI](#using-personal-access-tokens-with-cli-tool)
4. [Managing and Revoking Tokens](#managing-and-revoking-tokens)
5. [Best Practices for Token Management](#best-practices-for-token-management)

---

### 1. What Are Personal Access Tokens?
Personal Access Tokens (PATs) are unique strings that allow you to authenticate without requiring a username and
password each time. PATs are associated with your account and can be created for specific use cases, allowing granular
access to your app resources.

> **Note:** PATs should be treated like passwords and stored securely.

---

### 2. Setting Up Personal Access Tokens

To use Personal Access Tokens with the Choreo CLI, follow these steps to set up and retrieve a token from
the Choreo Console.

#### Step 1: Log into Your Account
1. Go to [Choreo Console](https://console.choreo.dev).
2. Navigate to **Account Settings**.
3. From the Account settings page go to **Personal Access Tokens** section.

![UserMenu](../assets/img/choreo-cli/personal-access-tokens/user-menu.png)
![AccountSettings](../assets/img/choreo-cli/personal-access-tokens/account-settings.png)

#### Step 2: Generate a New Token
1. Click on **Create New**.
2. Specify a name for your token and define its scope and permissions by default this would select all the necessary
scopes for the CLI to function.
3. Click **Generate**.

![GenerateForm](../assets/img/choreo-cli/personal-access-tokens/create-pat.png)
![GenerateForm](../assets/img/choreo-cli/personal-access-tokens/generated-pat.png)

4. Copy the token shown on the screen and store it securely. You won’t be able to view it again.

> **Warning:** Treat your token as confidential information. Do not share it or store it in unsecured files.

---

### 3. Using Personal Access Tokens with Choreo CLI

After generating your token, you can use it with Choreo CLI for various operations. Here’s how to authenticate with
a Personal Access Token.

#### Command Syntax
To use a token, use the login command with the flag `--with-token`:

```bash
choreo login --with-token
```

This command would read the token from the standard input

**Example:**
```bash
export CHOREO_TOKEN=<YOUR_PERSONAL_ACCESS_TOKEN>
echo "$CHOREO_TOKEN" | choreo login --with-token
```

> **Note:** Replace `YOUR_PERSONAL_ACCESS_TOKEN` with your actual token.

---

### 4. Managing and Revoking Tokens

To manage or revoke existing tokens, return to the **Personal Access Tokens** section in your account settings.

1. Locate the token you want to revoke.
2. Click on **Revoke** next to the token.

> **Tip:** Regularly review and revoke tokens that are no longer in use to maintain security.

![PatListing](../assets/img/choreo-cli/personal-access-tokens/pat-listing.png)

---

### 5. Best Practices for Token Management

- **Limit Scope:** Only grant the permissions needed for each use case.
- **Rotate Tokens Regularly:** Replace tokens periodically to reduce the risk of compromise.
- **Use Secure Storage:** Store tokens in a secure location, such as a secrets manager.
- **Revoke Unused Tokens:** Regularly audit and revoke tokens no longer required.

13 changes: 13 additions & 0 deletions en/docs/references/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -613,6 +613,19 @@ The build configurations required for existing buildpacks are as follows:
<ul>
</td>
</tr>
<tr>
<td>API proxy</td>
<td>n/a</td>
<td>
<ul>
<li>version: Api version in the form vX.X</li>
<li>context: Context for the API url</li>
<li>schemaFilePath: Open API specification file path relative to the component directory</li>
<li>endpointUrl: Target Endpoint url for the proxy</li>
<li>accessibility: Mode of the access for the API(internal|external)</li>
</ul>
</td>
</tr>
</tbody>
</table>

Expand Down