@hideandseeklab/aoox 0.1.0-alpha.12 → 0.1.0-alpha.13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +77 -30
- package/assets/install/docker-compose.dist.yml +9 -1
- package/dist/commands/install.d.ts +19 -0
- package/dist/commands/install.js +222 -73
- package/dist/commands/registry/password.d.ts +19 -0
- package/dist/commands/registry/password.js +74 -0
- package/dist/commands/reinstall.js +3 -12
- package/dist/commands/run.js +4 -0
- package/dist/commands/update/panel.js +24 -2
- package/dist/lib/docker.d.ts +1 -1
- package/dist/lib/docker.js +2 -2
- package/dist/lib/install-plan.d.ts +69 -0
- package/dist/lib/install-plan.js +86 -0
- package/dist/lib/leftover-volumes.d.ts +18 -0
- package/dist/lib/leftover-volumes.js +69 -0
- package/dist/lib/reinstall.d.ts +7 -0
- package/dist/lib/reinstall.js +28 -0
- package/dist/lib/types.d.ts +2 -0
- package/oclif.manifest.json +125 -41
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -27,7 +27,7 @@ $ npm install -g @hideandseeklab/aoox
|
|
|
27
27
|
$ aoox COMMAND
|
|
28
28
|
running command...
|
|
29
29
|
$ aoox (--version)
|
|
30
|
-
@hideandseeklab/aoox/0.1.0-alpha.
|
|
30
|
+
@hideandseeklab/aoox/0.1.0-alpha.13 linux-x64 node-v24.22.0
|
|
31
31
|
$ aoox --help [COMMAND]
|
|
32
32
|
USAGE
|
|
33
33
|
$ aoox COMMAND
|
|
@@ -100,6 +100,13 @@ npm link # or: npm install -g .
|
|
|
100
100
|
|
|
101
101
|
Names are lowercased; a `+` in a version becomes `_` (tags cannot contain it). A value that cannot be read with certainty (an MSBuild `$(...)` or Maven `${...}` variable, `version.workspace`) is skipped. If HEAD is past the last tag the CLI refuses instead of guessing (tag it, type `name:version`, or `--force` to use the `git describe` form `1.4.2-3-gabc1234`). Because the result is derived, the CLI prints where it came from and asks `Build web:1.4.2? (Y/n/e)` first (`Y` continue, `n` abort, `e` edit); `--yes` skips the question, and without a terminal (or with `CI` set) it refuses and asks for `name:version` or `--yes`. A fully typed `name:version` never asks. The "version already exists" check still applies, so forgetting to bump the version never overwrites an image.
|
|
102
102
|
|
|
103
|
+
## Installing on a machine that still has panel data
|
|
104
|
+
|
|
105
|
+
`aoox install` in an empty folder (no `.env.dist`, no compose file) first asks Docker whether the panel's data volume (`aoox_postgres_data`, and any other named volume the bundled compose file declares) already exists. If it does, a fresh install would generate a new `POSTGRES_PASSWORD` that cannot open the old database, so the command stops before writing anything and tells you to either:
|
|
106
|
+
|
|
107
|
+
- restore the old `.env.dist` (the message names the newest `<dir>/backups/<time>/` copy when there is one) and run `sudo aoox reinstall`, which keeps the data; or
|
|
108
|
+
- start from scratch with `sudo aoox install --force --new-secrets --wipe-data`, which removes those volumes (and the stack's own containers that still use them) after you type the folder, or pass `--confirm-wipe=<dir>`.
|
|
109
|
+
|
|
103
110
|
## Colours
|
|
104
111
|
|
|
105
112
|
Step lines (`==> ...`), results, warnings and hints are coloured when the output is a terminal. `NO_COLOR=1` turns colour off, `FORCE_COLOR=1` turns it on without a terminal (for example in some CI logs). Output meant for pipes (`aoox env pull` to stdout) and docker's own output are never coloured by the CLI.
|
|
@@ -150,6 +157,7 @@ verification is never turned off.
|
|
|
150
157
|
* [`aoox plugins update`](#aoox-plugins-update)
|
|
151
158
|
* [`aoox registry build [IMAGE]`](#aoox-registry-build-image)
|
|
152
159
|
* [`aoox registry domain`](#aoox-registry-domain)
|
|
160
|
+
* [`aoox registry password`](#aoox-registry-password)
|
|
153
161
|
* [`aoox registry push [IMAGE]`](#aoox-registry-push-image)
|
|
154
162
|
* [`aoox reinstall`](#aoox-reinstall)
|
|
155
163
|
* [`aoox run`](#aoox-run)
|
|
@@ -184,7 +192,7 @@ EXAMPLES
|
|
|
184
192
|
$ aoox deploy --tag v1.2.3
|
|
185
193
|
```
|
|
186
194
|
|
|
187
|
-
_See code: [src/commands/deploy.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.
|
|
195
|
+
_See code: [src/commands/deploy.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.13/src/commands/deploy.ts)_
|
|
188
196
|
|
|
189
197
|
## `aoox domain clear`
|
|
190
198
|
|
|
@@ -209,7 +217,7 @@ EXAMPLES
|
|
|
209
217
|
$ aoox domain clear --yes
|
|
210
218
|
```
|
|
211
219
|
|
|
212
|
-
_See code: [src/commands/domain/clear.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.
|
|
220
|
+
_See code: [src/commands/domain/clear.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.13/src/commands/domain/clear.ts)_
|
|
213
221
|
|
|
214
222
|
## `aoox domain set`
|
|
215
223
|
|
|
@@ -241,7 +249,7 @@ EXAMPLES
|
|
|
241
249
|
$ aoox domain set --web panel.example.com --api api.example.com --domain-only
|
|
242
250
|
```
|
|
243
251
|
|
|
244
|
-
_See code: [src/commands/domain/set.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.
|
|
252
|
+
_See code: [src/commands/domain/set.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.13/src/commands/domain/set.ts)_
|
|
245
253
|
|
|
246
254
|
## `aoox env diff`
|
|
247
255
|
|
|
@@ -274,7 +282,7 @@ EXAMPLES
|
|
|
274
282
|
$ aoox env diff --set shared --from staging --to production
|
|
275
283
|
```
|
|
276
284
|
|
|
277
|
-
_See code: [src/commands/env/diff.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.
|
|
285
|
+
_See code: [src/commands/env/diff.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.13/src/commands/env/diff.ts)_
|
|
278
286
|
|
|
279
287
|
## `aoox env history`
|
|
280
288
|
|
|
@@ -310,7 +318,7 @@ EXAMPLES
|
|
|
310
318
|
$ aoox env history --limit 5 --json
|
|
311
319
|
```
|
|
312
320
|
|
|
313
|
-
_See code: [src/commands/env/history.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.
|
|
321
|
+
_See code: [src/commands/env/history.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.13/src/commands/env/history.ts)_
|
|
314
322
|
|
|
315
323
|
## `aoox env link`
|
|
316
324
|
|
|
@@ -344,7 +352,7 @@ EXAMPLES
|
|
|
344
352
|
$ aoox env link --set defaults --env production --position 1
|
|
345
353
|
```
|
|
346
354
|
|
|
347
|
-
_See code: [src/commands/env/link.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.
|
|
355
|
+
_See code: [src/commands/env/link.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.13/src/commands/env/link.ts)_
|
|
348
356
|
|
|
349
357
|
## `aoox env links`
|
|
350
358
|
|
|
@@ -374,7 +382,7 @@ EXAMPLES
|
|
|
374
382
|
$ aoox env links --stack <id>
|
|
375
383
|
```
|
|
376
384
|
|
|
377
|
-
_See code: [src/commands/env/links.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.
|
|
385
|
+
_See code: [src/commands/env/links.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.13/src/commands/env/links.ts)_
|
|
378
386
|
|
|
379
387
|
## `aoox env list`
|
|
380
388
|
|
|
@@ -416,7 +424,7 @@ EXAMPLES
|
|
|
416
424
|
$ aoox env list --set shared --env development --reveal
|
|
417
425
|
```
|
|
418
426
|
|
|
419
|
-
_See code: [src/commands/env/list.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.
|
|
427
|
+
_See code: [src/commands/env/list.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.13/src/commands/env/list.ts)_
|
|
420
428
|
|
|
421
429
|
## `aoox env promote`
|
|
422
430
|
|
|
@@ -451,7 +459,7 @@ EXAMPLES
|
|
|
451
459
|
$ aoox env promote --from development --to staging --all --yes
|
|
452
460
|
```
|
|
453
461
|
|
|
454
|
-
_See code: [src/commands/env/promote.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.
|
|
462
|
+
_See code: [src/commands/env/promote.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.13/src/commands/env/promote.ts)_
|
|
455
463
|
|
|
456
464
|
## `aoox env pull`
|
|
457
465
|
|
|
@@ -495,7 +503,7 @@ EXAMPLES
|
|
|
495
503
|
$ aoox env pull --format shell --file -
|
|
496
504
|
```
|
|
497
505
|
|
|
498
|
-
_See code: [src/commands/env/pull.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.
|
|
506
|
+
_See code: [src/commands/env/pull.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.13/src/commands/env/pull.ts)_
|
|
499
507
|
|
|
500
508
|
## `aoox env push`
|
|
501
509
|
|
|
@@ -529,7 +537,7 @@ EXAMPLES
|
|
|
529
537
|
$ aoox env push --file .env.staging --set shared --env staging --yes
|
|
530
538
|
```
|
|
531
539
|
|
|
532
|
-
_See code: [src/commands/env/push.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.
|
|
540
|
+
_See code: [src/commands/env/push.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.13/src/commands/env/push.ts)_
|
|
533
541
|
|
|
534
542
|
## `aoox env set ASSIGNMENTS`
|
|
535
543
|
|
|
@@ -568,7 +576,7 @@ EXAMPLES
|
|
|
568
576
|
$ aoox env set API_TOKEN=abc123 --secret
|
|
569
577
|
```
|
|
570
578
|
|
|
571
|
-
_See code: [src/commands/env/set.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.
|
|
579
|
+
_See code: [src/commands/env/set.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.13/src/commands/env/set.ts)_
|
|
572
580
|
|
|
573
581
|
## `aoox env sets`
|
|
574
582
|
|
|
@@ -642,7 +650,7 @@ EXAMPLES
|
|
|
642
650
|
$ aoox env unlink --position 2
|
|
643
651
|
```
|
|
644
652
|
|
|
645
|
-
_See code: [src/commands/env/unlink.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.
|
|
653
|
+
_See code: [src/commands/env/unlink.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.13/src/commands/env/unlink.ts)_
|
|
646
654
|
|
|
647
655
|
## `aoox env unset KEYS`
|
|
648
656
|
|
|
@@ -676,7 +684,7 @@ EXAMPLES
|
|
|
676
684
|
$ aoox env unset A B --set shared --env staging
|
|
677
685
|
```
|
|
678
686
|
|
|
679
|
-
_See code: [src/commands/env/unset.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.
|
|
687
|
+
_See code: [src/commands/env/unset.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.13/src/commands/env/unset.ts)_
|
|
680
688
|
|
|
681
689
|
## `aoox help [COMMAND]`
|
|
682
690
|
|
|
@@ -705,23 +713,31 @@ Install aoox (postgres + api + web) on a fresh VPS with Docker Compose
|
|
|
705
713
|
```
|
|
706
714
|
USAGE
|
|
707
715
|
$ aoox install [--acme-email <value>] [--admin-name <value> --admin-email <value>] [--admin-password
|
|
708
|
-
<value> ] [--api-domain <value> --web-domain <value>] [--
|
|
709
|
-
[--terminal-ssh-user <value>] [-y]
|
|
716
|
+
<value> ] [--api-domain <value> --web-domain <value>] [--confirm-wipe <value>] [--dir <value>] [--force]
|
|
717
|
+
[--new-secrets] [--no-terminal-authorize] [--terminal-ssh-user <value>] [--wipe-data] [-y]
|
|
710
718
|
|
|
711
719
|
FLAGS
|
|
712
|
-
-y, --yes Do not ask for any confirmation
|
|
720
|
+
-y, --yes Do not ask for any confirmation (does not confirm a wipe)
|
|
713
721
|
--acme-email=<value> Required with --web-domain/--api-domain (Let’s Encrypt)
|
|
714
722
|
--admin-email=<value> Create the first owner without going through /setup in the browser
|
|
715
723
|
--admin-name=<value> Name of the first owner
|
|
716
724
|
--admin-password=<value> Password of the first owner (min. 8 characters)
|
|
717
725
|
--api-domain=<value> Domain for the API, served through the bundled proxy
|
|
726
|
+
--confirm-wipe=<value> Non-interactive confirmation for --wipe-data: must be exactly the install directory
|
|
727
|
+
(--yes alone is not enough)
|
|
718
728
|
--dir=<value> [default: /opt/aoox] Installation directory
|
|
719
|
-
--force
|
|
729
|
+
--force Reinstall over an existing installation in --dir: previous files are backed up to
|
|
730
|
+
<dir>/backups/ and existing secrets and values are kept (data survives)
|
|
731
|
+
--new-secrets Only with --force --wipe-data: generate new secrets for a completely fresh install
|
|
732
|
+
(DELETES all panel data)
|
|
720
733
|
--no-terminal-authorize Do not create/authorize the web Terminal SSH key automatically (do it in Settings >
|
|
721
734
|
Terminal instead)
|
|
722
735
|
--terminal-ssh-user=<value> SSH user the web Terminal uses to log in to this host (default: the user running
|
|
723
736
|
sudo, or root if there is none)
|
|
724
737
|
--web-domain=<value> Domain for the web panel, served through the bundled proxy
|
|
738
|
+
--wipe-data Only with --force --new-secrets: run `docker compose down -v` first, removing the
|
|
739
|
+
panel database volume (and any leftover panel volumes from an earlier install)
|
|
740
|
+
(DELETES all panel data)
|
|
725
741
|
|
|
726
742
|
DESCRIPTION
|
|
727
743
|
Install aoox (postgres + api + web) on a fresh VPS with Docker Compose
|
|
@@ -730,9 +746,13 @@ EXAMPLES
|
|
|
730
746
|
sudo aoox install
|
|
731
747
|
|
|
732
748
|
sudo aoox install --web-domain panel.example.com --api-domain api.panel.example.com --acme-email me@example.com
|
|
749
|
+
|
|
750
|
+
sudo aoox install --force # reinstall over an existing install, keeping data and secrets
|
|
751
|
+
|
|
752
|
+
sudo aoox install --force --new-secrets --wipe-data # start from scratch (deletes all panel data)
|
|
733
753
|
```
|
|
734
754
|
|
|
735
|
-
_See code: [src/commands/install.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.
|
|
755
|
+
_See code: [src/commands/install.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.13/src/commands/install.ts)_
|
|
736
756
|
|
|
737
757
|
## `aoox link`
|
|
738
758
|
|
|
@@ -759,7 +779,7 @@ EXAMPLES
|
|
|
759
779
|
$ aoox link --project <id> --app <id>
|
|
760
780
|
```
|
|
761
781
|
|
|
762
|
-
_See code: [src/commands/link.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.
|
|
782
|
+
_See code: [src/commands/link.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.13/src/commands/link.ts)_
|
|
763
783
|
|
|
764
784
|
## `aoox login`
|
|
765
785
|
|
|
@@ -785,7 +805,7 @@ EXAMPLES
|
|
|
785
805
|
$ aoox login --url 203.0.113.10:3000 --token aoox_xxx
|
|
786
806
|
```
|
|
787
807
|
|
|
788
|
-
_See code: [src/commands/login.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.
|
|
808
|
+
_See code: [src/commands/login.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.13/src/commands/login.ts)_
|
|
789
809
|
|
|
790
810
|
## `aoox plugins`
|
|
791
811
|
|
|
@@ -1123,7 +1143,7 @@ EXAMPLES
|
|
|
1123
1143
|
$ aoox registry build myapp:1.0.0 --force
|
|
1124
1144
|
```
|
|
1125
1145
|
|
|
1126
|
-
_See code: [src/commands/registry/build.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.
|
|
1146
|
+
_See code: [src/commands/registry/build.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.13/src/commands/registry/build.ts)_
|
|
1127
1147
|
|
|
1128
1148
|
## `aoox registry domain`
|
|
1129
1149
|
|
|
@@ -1149,7 +1169,34 @@ EXAMPLES
|
|
|
1149
1169
|
$ aoox registry domain --clear
|
|
1150
1170
|
```
|
|
1151
1171
|
|
|
1152
|
-
_See code: [src/commands/registry/domain.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.
|
|
1172
|
+
_See code: [src/commands/registry/domain.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.13/src/commands/registry/domain.ts)_
|
|
1173
|
+
|
|
1174
|
+
## `aoox registry password`
|
|
1175
|
+
|
|
1176
|
+
Show or reset the password of the self-hosted registry
|
|
1177
|
+
|
|
1178
|
+
```
|
|
1179
|
+
USAGE
|
|
1180
|
+
$ aoox registry password [-t <value>] [-u <value>] [--reset] [--show] [-y]
|
|
1181
|
+
|
|
1182
|
+
FLAGS
|
|
1183
|
+
-t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
|
|
1184
|
+
-u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
|
|
1185
|
+
https://dashboard.example.com); defaults to the value from `aoox login`
|
|
1186
|
+
-y, --yes Confirm --reset without asking
|
|
1187
|
+
--reset Generate a new password (owner only). Images are kept; docker login again afterwards
|
|
1188
|
+
--show Print the current username, address and password
|
|
1189
|
+
|
|
1190
|
+
DESCRIPTION
|
|
1191
|
+
Show or reset the password of the self-hosted registry
|
|
1192
|
+
|
|
1193
|
+
EXAMPLES
|
|
1194
|
+
$ aoox registry password --show
|
|
1195
|
+
|
|
1196
|
+
$ aoox registry password --reset --yes
|
|
1197
|
+
```
|
|
1198
|
+
|
|
1199
|
+
_See code: [src/commands/registry/password.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.13/src/commands/registry/password.ts)_
|
|
1153
1200
|
|
|
1154
1201
|
## `aoox registry push [IMAGE]`
|
|
1155
1202
|
|
|
@@ -1189,7 +1236,7 @@ EXAMPLES
|
|
|
1189
1236
|
$ aoox registry push myapp:1.0.0 --force
|
|
1190
1237
|
```
|
|
1191
1238
|
|
|
1192
|
-
_See code: [src/commands/registry/push.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.
|
|
1239
|
+
_See code: [src/commands/registry/push.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.13/src/commands/registry/push.ts)_
|
|
1193
1240
|
|
|
1194
1241
|
## `aoox reinstall`
|
|
1195
1242
|
|
|
@@ -1219,7 +1266,7 @@ EXAMPLES
|
|
|
1219
1266
|
sudo aoox reinstall --yes --terminal-ssh-user root
|
|
1220
1267
|
```
|
|
1221
1268
|
|
|
1222
|
-
_See code: [src/commands/reinstall.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.
|
|
1269
|
+
_See code: [src/commands/reinstall.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.13/src/commands/reinstall.ts)_
|
|
1223
1270
|
|
|
1224
1271
|
## `aoox run`
|
|
1225
1272
|
|
|
@@ -1264,7 +1311,7 @@ EXAMPLES
|
|
|
1264
1311
|
$ aoox run --quiet -- npm run dev
|
|
1265
1312
|
```
|
|
1266
1313
|
|
|
1267
|
-
_See code: [src/commands/run.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.
|
|
1314
|
+
_See code: [src/commands/run.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.13/src/commands/run.ts)_
|
|
1268
1315
|
|
|
1269
1316
|
## `aoox update`
|
|
1270
1317
|
|
|
@@ -1286,7 +1333,7 @@ EXAMPLES
|
|
|
1286
1333
|
$ aoox update --check
|
|
1287
1334
|
```
|
|
1288
1335
|
|
|
1289
|
-
_See code: [src/commands/update.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.
|
|
1336
|
+
_See code: [src/commands/update.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.13/src/commands/update.ts)_
|
|
1290
1337
|
|
|
1291
1338
|
## `aoox update panel`
|
|
1292
1339
|
|
|
@@ -1311,7 +1358,7 @@ EXAMPLES
|
|
|
1311
1358
|
$ aoox update panel --apply
|
|
1312
1359
|
```
|
|
1313
1360
|
|
|
1314
|
-
_See code: [src/commands/update/panel.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.
|
|
1361
|
+
_See code: [src/commands/update/panel.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.13/src/commands/update/panel.ts)_
|
|
1315
1362
|
|
|
1316
1363
|
## `aoox whoami`
|
|
1317
1364
|
|
|
@@ -1338,7 +1385,7 @@ EXAMPLES
|
|
|
1338
1385
|
$ aoox whoami --json
|
|
1339
1386
|
```
|
|
1340
1387
|
|
|
1341
|
-
_See code: [src/commands/whoami.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.
|
|
1388
|
+
_See code: [src/commands/whoami.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.13/src/commands/whoami.ts)_
|
|
1342
1389
|
<!-- commandsstop -->
|
|
1343
1390
|
|
|
1344
1391
|
## Versioning
|
|
@@ -86,7 +86,13 @@ services:
|
|
|
86
86
|
# Self-hosted registry container is started by the API on the host engine.
|
|
87
87
|
REGISTRY_PORT: ${REGISTRY_PORT:-5000}
|
|
88
88
|
REGISTRY_PUBLIC_HOST: ${REGISTRY_PUBLIC_HOST:-localhost}
|
|
89
|
-
|
|
89
|
+
# Interface the registry's host port is published on. Default 127.0.0.1 (this
|
|
90
|
+
# server only); 0.0.0.0 lets other machines push by IP. Applied when the
|
|
91
|
+
# registry container is (re)created.
|
|
92
|
+
REGISTRY_PUBLISH_ADDRESS: ${REGISTRY_PUBLISH_ADDRESS:-}
|
|
93
|
+
# The API reaches the registry over the `aoox` network (a loopback-only host port
|
|
94
|
+
# is not reachable through host.docker.internal on Linux).
|
|
95
|
+
REGISTRY_INTERNAL_URL: http://aoox-registry:5000
|
|
90
96
|
# Traefik reverse proxy (container started by the API on the host engine)
|
|
91
97
|
PROXY_HTTP_PORT: ${PROXY_HTTP_PORT:-80}
|
|
92
98
|
PROXY_HTTPS_PORT: ${PROXY_HTTPS_PORT:-443}
|
|
@@ -100,6 +106,8 @@ services:
|
|
|
100
106
|
BUILDKIT_CACHE_KEEP_GB: ${BUILDKIT_CACHE_KEEP_GB:-10}
|
|
101
107
|
CONTAINER_LOG_MAX_SIZE: ${CONTAINER_LOG_MAX_SIZE:-10m}
|
|
102
108
|
CONTAINER_LOG_MAX_FILE: ${CONTAINER_LOG_MAX_FILE:-3}
|
|
109
|
+
# Time zone cron schedules (jobs, backups, nightly maintenance) run in; UTC when unset.
|
|
110
|
+
TZ: ${TZ:-UTC}
|
|
103
111
|
# Public IP app domains must point at (DNS check); auto-detected when empty.
|
|
104
112
|
PUBLIC_IP: ${PUBLIC_IP:-}
|
|
105
113
|
# Host port the web is published on (same value as the `web` port mapping); only used
|
|
@@ -8,11 +8,14 @@ export default class Install extends Command {
|
|
|
8
8
|
'admin-name': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
9
9
|
'admin-password': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
10
10
|
'api-domain': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
11
|
+
'confirm-wipe': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
11
12
|
dir: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
|
|
12
13
|
force: import("@oclif/core/interfaces").BooleanFlag<boolean>;
|
|
14
|
+
'new-secrets': import("@oclif/core/interfaces").BooleanFlag<boolean>;
|
|
13
15
|
'no-terminal-authorize': import("@oclif/core/interfaces").BooleanFlag<boolean>;
|
|
14
16
|
'terminal-ssh-user': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
15
17
|
'web-domain': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
18
|
+
'wipe-data': import("@oclif/core/interfaces").BooleanFlag<boolean>;
|
|
16
19
|
yes: import("@oclif/core/interfaces").BooleanFlag<boolean>;
|
|
17
20
|
};
|
|
18
21
|
run(): Promise<void>;
|
|
@@ -23,6 +26,22 @@ export default class Install extends Command {
|
|
|
23
26
|
private chownNode;
|
|
24
27
|
private confirmPlan;
|
|
25
28
|
private ensureDocker;
|
|
29
|
+
/**
|
|
30
|
+
* Data volumes of an earlier installation that are still on this Docker host while the install folder is
|
|
31
|
+
* empty. Only asked when Docker already runs: without Docker there cannot be any.
|
|
32
|
+
*/
|
|
33
|
+
private findLeftoverVolumes;
|
|
34
|
+
private presentFiles;
|
|
35
|
+
/**
|
|
36
|
+
* Volumes from an earlier installation whose folder is gone (so there is no compose file to `down -v` with).
|
|
37
|
+
* Removes the stack's own containers that still hold them, then the volumes. A volume that is still in use by
|
|
38
|
+
* anything else makes docker refuse, and the install stops there with docker's own message.
|
|
39
|
+
*/
|
|
40
|
+
private removeLeftoverVolumes;
|
|
41
|
+
/** Reuse mode: the existing `.env.dist` is merged, never regenerated; only explicit flags replace values. */
|
|
42
|
+
private reuseEnv;
|
|
26
43
|
/** Polls the API's own setup-status endpoint — migrations run on boot, so "up" isn't "ready". */
|
|
27
44
|
private waitReady;
|
|
45
|
+
/** `docker compose down -v` for the existing stack (dist + domain file only: the override just changes ports/labels). */
|
|
46
|
+
private wipe;
|
|
28
47
|
}
|