@hideandseeklab/aoox 0.1.0-alpha.11 → 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.
Files changed (64) hide show
  1. package/README.md +179 -45
  2. package/assets/install/docker-compose.dist.yml +15 -1
  3. package/bin/dev.js +8 -2
  4. package/bin/run.js +6 -2
  5. package/dist/commands/deploy.js +8 -7
  6. package/dist/commands/domain/clear.d.ts +16 -0
  7. package/dist/commands/domain/clear.js +61 -0
  8. package/dist/commands/domain/set.d.ts +1 -0
  9. package/dist/commands/domain/set.js +15 -3
  10. package/dist/commands/env/promote.js +2 -1
  11. package/dist/commands/env/pull.js +4 -3
  12. package/dist/commands/env/push.js +3 -2
  13. package/dist/commands/env/set.js +2 -1
  14. package/dist/commands/env/unset.js +3 -2
  15. package/dist/commands/install.d.ts +19 -0
  16. package/dist/commands/install.js +232 -82
  17. package/dist/commands/link.js +4 -3
  18. package/dist/commands/login.js +4 -3
  19. package/dist/commands/registry/build.d.ts +3 -1
  20. package/dist/commands/registry/build.js +12 -6
  21. package/dist/commands/registry/domain.js +3 -2
  22. package/dist/commands/registry/password.d.ts +19 -0
  23. package/dist/commands/registry/password.js +74 -0
  24. package/dist/commands/registry/push.d.ts +2 -1
  25. package/dist/commands/registry/push.js +6 -3
  26. package/dist/commands/reinstall.js +26 -20
  27. package/dist/commands/run.js +7 -2
  28. package/dist/commands/update/panel.js +28 -5
  29. package/dist/commands/update.js +6 -5
  30. package/dist/commands/whoami.js +2 -1
  31. package/dist/lib/api.js +2 -2
  32. package/dist/lib/compose-version.d.ts +26 -0
  33. package/dist/lib/compose-version.js +61 -0
  34. package/dist/lib/discovery.d.ts +24 -2
  35. package/dist/lib/discovery.js +97 -3
  36. package/dist/lib/docker.d.ts +1 -1
  37. package/dist/lib/docker.js +2 -2
  38. package/dist/lib/env-command.d.ts +1 -1
  39. package/dist/lib/env-command.js +4 -3
  40. package/dist/lib/image-confirm.d.ts +38 -0
  41. package/dist/lib/image-confirm.js +102 -0
  42. package/dist/lib/image-source.d.ts +59 -0
  43. package/dist/lib/image-source.js +261 -0
  44. package/dist/lib/install-plan.d.ts +69 -0
  45. package/dist/lib/install-plan.js +86 -0
  46. package/dist/lib/interrupt.d.ts +19 -0
  47. package/dist/lib/interrupt.js +42 -0
  48. package/dist/lib/leftover-volumes.d.ts +18 -0
  49. package/dist/lib/leftover-volumes.js +69 -0
  50. package/dist/lib/manifest-parsers.d.ts +23 -0
  51. package/dist/lib/manifest-parsers.js +152 -0
  52. package/dist/lib/registry-image-command.d.ts +20 -3
  53. package/dist/lib/registry-image-command.js +56 -14
  54. package/dist/lib/reinstall.d.ts +7 -0
  55. package/dist/lib/reinstall.js +28 -0
  56. package/dist/lib/run-banner.d.ts +3 -12
  57. package/dist/lib/run-banner.js +2 -23
  58. package/dist/lib/style.d.ts +34 -0
  59. package/dist/lib/style.js +75 -0
  60. package/dist/lib/system-ca.d.ts +20 -0
  61. package/dist/lib/system-ca.js +29 -0
  62. package/dist/lib/types.d.ts +2 -0
  63. package/oclif.manifest.json +174 -13
  64. 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.11 linux-x64 node-v24.21.0
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
@@ -81,9 +81,53 @@ npm run build
81
81
  npm link # or: npm install -g .
82
82
  ```
83
83
 
84
+ ## Image name and version from the project
85
+
86
+ `aoox registry build` and `aoox registry push` do not need `name:version` typed in full. With no argument (or a name without a version) the CLI fills the gaps, in this order, from the build context (`push`: the current directory); the first source that has the value wins and is named in the output:
87
+
88
+ | # | Source | Name | Version |
89
+ | - | ------ | ---- | ------- |
90
+ | 1 | `package.json` | `name`, npm scope removed (`@acme/web` becomes `web`) | `version` |
91
+ | 2 | `pyproject.toml` | `[project]` or `[tool.poetry]` name | version (skipped when `dynamic`) |
92
+ | 3 | `Cargo.toml` | `[package]` name | `[package]` version (not a workspace one) |
93
+ | 4 | `composer.json` | `name`, vendor removed | `version`, if present |
94
+ | 5 | `pubspec.yaml` | `name` | `version` |
95
+ | 6 | `*.csproj` (exactly one) | `AssemblyName`, else the file name | `Version`, or `VersionPrefix`-`VersionSuffix` |
96
+ | 7 | `pom.xml` | project `artifactId` | project `version` (not the parent's) |
97
+ | 8 | `VERSION` | - | first non-empty line |
98
+ | 9 | git tag | - | the tag HEAD is exactly on, leading `v` removed |
99
+ | 10 | folder name | the folder, lowercased | - |
100
+
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
+
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
+
110
+ ## Colours
111
+
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.
113
+
114
+ ## Behind an antivirus or corporate proxy
115
+
116
+ Antivirus HTTPS scanning (AVG, Avast, Kaspersky, ESET, Bitdefender) and corporate proxies (Zscaler,
117
+ Netskope, Fortinet, Palo Alto) re-sign HTTPS traffic with their own root certificate, which is
118
+ installed in the operating system's store but unknown to Node. On Node 22.19+ / 24.5+ aoox trusts
119
+ the system store in addition to Node's bundled list, so this works without any setup. Certificate
120
+ verification is never turned off.
121
+
122
+ - `AOOX_SYSTEM_CA=0` opts out (Node's bundled list only).
123
+ - `NODE_EXTRA_CA_CERTS=<root.pem>` still works and is kept.
124
+ - On older Node, set `NODE_OPTIONS=--use-system-ca` (Node 22.15+/23.10+), or upgrade Node, or add the panel's domain to the antivirus HTTPS-scanning exclusions.
125
+ - If verification still fails because of an unknown issuer, the error names the issuer it saw.
126
+
84
127
  # Commands
85
128
  <!-- commands -->
86
129
  * [`aoox deploy`](#aoox-deploy)
130
+ * [`aoox domain clear`](#aoox-domain-clear)
87
131
  * [`aoox domain set`](#aoox-domain-set)
88
132
  * [`aoox env diff`](#aoox-env-diff)
89
133
  * [`aoox env history`](#aoox-env-history)
@@ -111,9 +155,10 @@ npm link # or: npm install -g .
111
155
  * [`aoox plugins uninstall [PLUGIN]`](#aoox-plugins-uninstall-plugin)
112
156
  * [`aoox plugins unlink [PLUGIN]`](#aoox-plugins-unlink-plugin)
113
157
  * [`aoox plugins update`](#aoox-plugins-update)
114
- * [`aoox registry build IMAGE`](#aoox-registry-build-image)
158
+ * [`aoox registry build [IMAGE]`](#aoox-registry-build-image)
115
159
  * [`aoox registry domain`](#aoox-registry-domain)
116
- * [`aoox registry push IMAGE`](#aoox-registry-push-image)
160
+ * [`aoox registry password`](#aoox-registry-password)
161
+ * [`aoox registry push [IMAGE]`](#aoox-registry-push-image)
117
162
  * [`aoox reinstall`](#aoox-reinstall)
118
163
  * [`aoox run`](#aoox-run)
119
164
  * [`aoox update`](#aoox-update)
@@ -147,7 +192,32 @@ EXAMPLES
147
192
  $ aoox deploy --tag v1.2.3
148
193
  ```
149
194
 
150
- _See code: [src/commands/deploy.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.11/src/commands/deploy.ts)_
195
+ _See code: [src/commands/deploy.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.13/src/commands/deploy.ts)_
196
+
197
+ ## `aoox domain clear`
198
+
199
+ Remove the custom domain of the panel itself and go back to IP access (IP:3000) through the running panel API
200
+
201
+ ```
202
+ USAGE
203
+ $ aoox domain clear [-t <value>] [-u <value>] [-y]
204
+
205
+ FLAGS
206
+ -t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
207
+ -u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
208
+ https://dashboard.example.com); defaults to the value from `aoox login`
209
+ -y, --yes Do not ask for confirmation
210
+
211
+ DESCRIPTION
212
+ Remove the custom domain of the panel itself and go back to IP access (IP:3000) through the running panel API
213
+
214
+ EXAMPLES
215
+ $ aoox domain clear
216
+
217
+ $ aoox domain clear --yes
218
+ ```
219
+
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)_
151
221
 
152
222
  ## `aoox domain set`
153
223
 
@@ -155,7 +225,7 @@ Set a custom domain for the panel itself (not an application) through the runnin
155
225
 
156
226
  ```
157
227
  USAGE
158
- $ aoox domain set --api <value> --web <value> [-t <value>] [-u <value>] [--acme-email <value>]
228
+ $ aoox domain set --api <value> --web <value> [-t <value>] [-u <value>] [--acme-email <value>] [--domain-only]
159
229
 
160
230
  FLAGS
161
231
  -t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
@@ -163,6 +233,9 @@ FLAGS
163
233
  https://dashboard.example.com); defaults to the value from `aoox login`
164
234
  --acme-email=<value> Email for the Let's Encrypt certificate
165
235
  --api=<value> (required) Domain for the panel API
236
+ --[no-]domain-only Only allow access through the domain: ports 3000/3001 listen on 127.0.0.1 only (default:
237
+ keep the current setting). Use --no-domain-only to open them again. Make sure the domain
238
+ works first, or you lose IP:port access
166
239
  --web=<value> (required) Domain for the panel dashboard
167
240
 
168
241
  DESCRIPTION
@@ -172,9 +245,11 @@ EXAMPLES
172
245
  $ aoox domain set --web panel.example.com --api api.example.com
173
246
 
174
247
  $ aoox domain set --web panel.example.com --api api.example.com --acme-email you@example.com
248
+
249
+ $ aoox domain set --web panel.example.com --api api.example.com --domain-only
175
250
  ```
176
251
 
177
- _See code: [src/commands/domain/set.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.11/src/commands/domain/set.ts)_
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)_
178
253
 
179
254
  ## `aoox env diff`
180
255
 
@@ -207,7 +282,7 @@ EXAMPLES
207
282
  $ aoox env diff --set shared --from staging --to production
208
283
  ```
209
284
 
210
- _See code: [src/commands/env/diff.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.11/src/commands/env/diff.ts)_
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)_
211
286
 
212
287
  ## `aoox env history`
213
288
 
@@ -243,7 +318,7 @@ EXAMPLES
243
318
  $ aoox env history --limit 5 --json
244
319
  ```
245
320
 
246
- _See code: [src/commands/env/history.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.11/src/commands/env/history.ts)_
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)_
247
322
 
248
323
  ## `aoox env link`
249
324
 
@@ -277,7 +352,7 @@ EXAMPLES
277
352
  $ aoox env link --set defaults --env production --position 1
278
353
  ```
279
354
 
280
- _See code: [src/commands/env/link.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.11/src/commands/env/link.ts)_
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)_
281
356
 
282
357
  ## `aoox env links`
283
358
 
@@ -307,7 +382,7 @@ EXAMPLES
307
382
  $ aoox env links --stack <id>
308
383
  ```
309
384
 
310
- _See code: [src/commands/env/links.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.11/src/commands/env/links.ts)_
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)_
311
386
 
312
387
  ## `aoox env list`
313
388
 
@@ -349,7 +424,7 @@ EXAMPLES
349
424
  $ aoox env list --set shared --env development --reveal
350
425
  ```
351
426
 
352
- _See code: [src/commands/env/list.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.11/src/commands/env/list.ts)_
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)_
353
428
 
354
429
  ## `aoox env promote`
355
430
 
@@ -384,7 +459,7 @@ EXAMPLES
384
459
  $ aoox env promote --from development --to staging --all --yes
385
460
  ```
386
461
 
387
- _See code: [src/commands/env/promote.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.11/src/commands/env/promote.ts)_
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)_
388
463
 
389
464
  ## `aoox env pull`
390
465
 
@@ -428,7 +503,7 @@ EXAMPLES
428
503
  $ aoox env pull --format shell --file -
429
504
  ```
430
505
 
431
- _See code: [src/commands/env/pull.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.11/src/commands/env/pull.ts)_
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)_
432
507
 
433
508
  ## `aoox env push`
434
509
 
@@ -462,7 +537,7 @@ EXAMPLES
462
537
  $ aoox env push --file .env.staging --set shared --env staging --yes
463
538
  ```
464
539
 
465
- _See code: [src/commands/env/push.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.11/src/commands/env/push.ts)_
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)_
466
541
 
467
542
  ## `aoox env set ASSIGNMENTS`
468
543
 
@@ -501,7 +576,7 @@ EXAMPLES
501
576
  $ aoox env set API_TOKEN=abc123 --secret
502
577
  ```
503
578
 
504
- _See code: [src/commands/env/set.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.11/src/commands/env/set.ts)_
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)_
505
580
 
506
581
  ## `aoox env sets`
507
582
 
@@ -575,7 +650,7 @@ EXAMPLES
575
650
  $ aoox env unlink --position 2
576
651
  ```
577
652
 
578
- _See code: [src/commands/env/unlink.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.11/src/commands/env/unlink.ts)_
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)_
579
654
 
580
655
  ## `aoox env unset KEYS`
581
656
 
@@ -609,7 +684,7 @@ EXAMPLES
609
684
  $ aoox env unset A B --set shared --env staging
610
685
  ```
611
686
 
612
- _See code: [src/commands/env/unset.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.11/src/commands/env/unset.ts)_
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)_
613
688
 
614
689
  ## `aoox help [COMMAND]`
615
690
 
@@ -638,23 +713,31 @@ Install aoox (postgres + api + web) on a fresh VPS with Docker Compose
638
713
  ```
639
714
  USAGE
640
715
  $ aoox install [--acme-email <value>] [--admin-name <value> --admin-email <value>] [--admin-password
641
- <value> ] [--api-domain <value> --web-domain <value>] [--dir <value>] [--force] [--no-terminal-authorize]
642
- [--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]
643
718
 
644
719
  FLAGS
645
- -y, --yes Do not ask for any confirmation
720
+ -y, --yes Do not ask for any confirmation (does not confirm a wipe)
646
721
  --acme-email=<value> Required with --web-domain/--api-domain (Let’s Encrypt)
647
722
  --admin-email=<value> Create the first owner without going through /setup in the browser
648
723
  --admin-name=<value> Name of the first owner
649
724
  --admin-password=<value> Password of the first owner (min. 8 characters)
650
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)
651
728
  --dir=<value> [default: /opt/aoox] Installation directory
652
- --force Overwrite an existing installation in --dir
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)
653
733
  --no-terminal-authorize Do not create/authorize the web Terminal SSH key automatically (do it in Settings >
654
734
  Terminal instead)
655
735
  --terminal-ssh-user=<value> SSH user the web Terminal uses to log in to this host (default: the user running
656
736
  sudo, or root if there is none)
657
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)
658
741
 
659
742
  DESCRIPTION
660
743
  Install aoox (postgres + api + web) on a fresh VPS with Docker Compose
@@ -663,9 +746,13 @@ EXAMPLES
663
746
  sudo aoox install
664
747
 
665
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)
666
753
  ```
667
754
 
668
- _See code: [src/commands/install.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.11/src/commands/install.ts)_
755
+ _See code: [src/commands/install.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.13/src/commands/install.ts)_
669
756
 
670
757
  ## `aoox link`
671
758
 
@@ -692,7 +779,7 @@ EXAMPLES
692
779
  $ aoox link --project <id> --app <id>
693
780
  ```
694
781
 
695
- _See code: [src/commands/link.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.11/src/commands/link.ts)_
782
+ _See code: [src/commands/link.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.13/src/commands/link.ts)_
696
783
 
697
784
  ## `aoox login`
698
785
 
@@ -718,7 +805,7 @@ EXAMPLES
718
805
  $ aoox login --url 203.0.113.10:3000 --token aoox_xxx
719
806
  ```
720
807
 
721
- _See code: [src/commands/login.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.11/src/commands/login.ts)_
808
+ _See code: [src/commands/login.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.13/src/commands/login.ts)_
722
809
 
723
810
  ## `aoox plugins`
724
811
 
@@ -1010,34 +1097,45 @@ DESCRIPTION
1010
1097
 
1011
1098
  _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.5.2/src/commands/plugins/update.ts)_
1012
1099
 
1013
- ## `aoox registry build IMAGE`
1100
+ ## `aoox registry build [IMAGE]`
1014
1101
 
1015
- Build an image from a Dockerfile, named for the aoox registry (refuses a version that already exists there)
1102
+ Build an image from a Dockerfile, named for the aoox registry (refuses a version that already exists there). A name or version you leave out is taken from the project (you confirm it first, or pass --yes)
1016
1103
 
1017
1104
  ```
1018
1105
  USAGE
1019
- $ aoox registry build IMAGE [-t <value>] [-u <value>] [--force] [--registry <value>] [--context <value>] [-f
1020
- <value>] [--push]
1106
+ $ aoox registry build [IMAGE] [-t <value>] [-u <value>] [--force] [--registry <value>] [-y] [--context <value>]
1107
+ [-f <value>] [--push]
1021
1108
 
1022
1109
  ARGUMENTS
1023
- IMAGE Image name and version, e.g. myapp:1.0.0
1110
+ [IMAGE] Image name and version, e.g. myapp:1.0.0. Omit it (or the version) to read them from the project in the build
1111
+ context: package.json, pyproject.toml, Cargo.toml, composer.json, pubspec.yaml, *.csproj, pom.xml, a VERSION
1112
+ file or a git tag
1024
1113
 
1025
1114
  FLAGS
1026
1115
  -f, --dockerfile=<value> [default: Dockerfile] Path to the Dockerfile
1027
1116
  -t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
1028
1117
  -u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
1029
1118
  https://dashboard.example.com); defaults to the value from `aoox login`
1119
+ -y, --yes Do not ask to confirm an image name or version taken from the project
1030
1120
  --context=<value> [default: .] Docker build context
1031
- --force Overwrite a version that already exists in the registry
1121
+ --force Overwrite a version that already exists in the registry (also lets a version be taken from a
1122
+ git tag HEAD is past)
1032
1123
  --push Push the image to the registry right after the build
1033
1124
  --registry=<value> Registry ID; defaults to the self-hosted registry
1034
1125
 
1035
1126
  DESCRIPTION
1036
- Build an image from a Dockerfile, named for the aoox registry (refuses a version that already exists there)
1127
+ Build an image from a Dockerfile, named for the aoox registry (refuses a version that already exists there). A name or
1128
+ version you leave out is taken from the project (you confirm it first, or pass --yes)
1037
1129
 
1038
1130
  EXAMPLES
1039
1131
  $ aoox registry build myapp:1.0.0
1040
1132
 
1133
+ $ aoox registry build --push
1134
+
1135
+ $ aoox registry build myapp --context ./app
1136
+
1137
+ $ aoox registry build --push --yes
1138
+
1041
1139
  $ aoox registry build myapp:1.0.0 --push
1042
1140
 
1043
1141
  $ aoox registry build team/api:2.1.0 -f docker/Dockerfile --context .
@@ -1045,7 +1143,7 @@ EXAMPLES
1045
1143
  $ aoox registry build myapp:1.0.0 --force
1046
1144
  ```
1047
1145
 
1048
- _See code: [src/commands/registry/build.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.11/src/commands/registry/build.ts)_
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)_
1049
1147
 
1050
1148
  ## `aoox registry domain`
1051
1149
 
@@ -1071,38 +1169,74 @@ EXAMPLES
1071
1169
  $ aoox registry domain --clear
1072
1170
  ```
1073
1171
 
1074
- _See code: [src/commands/registry/domain.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.11/src/commands/registry/domain.ts)_
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)_
1075
1173
 
1076
- ## `aoox registry push IMAGE`
1174
+ ## `aoox registry password`
1077
1175
 
1078
- Push a local image to the aoox registry (refuses a version that already exists there)
1176
+ Show or reset the password of the self-hosted registry
1079
1177
 
1080
1178
  ```
1081
1179
  USAGE
1082
- $ aoox registry push IMAGE [-t <value>] [-u <value>] [--force] [--registry <value>]
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)_
1200
+
1201
+ ## `aoox registry push [IMAGE]`
1202
+
1203
+ Push a local image to the aoox registry (refuses a version that already exists there). A name or version you leave out is taken from the project (you confirm it first, or pass --yes)
1204
+
1205
+ ```
1206
+ USAGE
1207
+ $ aoox registry push [IMAGE] [-t <value>] [-u <value>] [--force] [--registry <value>] [-y]
1083
1208
 
1084
1209
  ARGUMENTS
1085
- IMAGE Image name and version (short or full), e.g. myapp:1.0.0
1210
+ [IMAGE] Image name and version (short or full), e.g. myapp:1.0.0. Omit it (or the version) to read them from the
1211
+ project in the current directory: package.json, pyproject.toml, Cargo.toml, composer.json, pubspec.yaml,
1212
+ *.csproj, pom.xml, a VERSION file or a git tag
1086
1213
 
1087
1214
  FLAGS
1088
1215
  -t, --token=<value> [env: AOOX_TOKEN] API token (aoox_…); defaults to the value from `aoox login`
1089
1216
  -u, --url=<value> [env: AOOX_URL] Dashboard URL (the address you open the dashboard with, e.g.
1090
1217
  https://dashboard.example.com); defaults to the value from `aoox login`
1091
- --force Overwrite a version that already exists in the registry
1218
+ -y, --yes Do not ask to confirm an image name or version taken from the project
1219
+ --force Overwrite a version that already exists in the registry (also lets a version be taken from a
1220
+ git tag HEAD is past)
1092
1221
  --registry=<value> Registry ID; defaults to the self-hosted registry
1093
1222
 
1094
1223
  DESCRIPTION
1095
- Push a local image to the aoox registry (refuses a version that already exists there)
1224
+ Push a local image to the aoox registry (refuses a version that already exists there). A name or version you leave out
1225
+ is taken from the project (you confirm it first, or pass --yes)
1096
1226
 
1097
1227
  EXAMPLES
1098
1228
  $ aoox registry push myapp:1.0.0
1099
1229
 
1230
+ $ aoox registry push
1231
+
1232
+ $ aoox registry push myapp
1233
+
1100
1234
  $ aoox registry push registry.example.com/myapp:1.0.0
1101
1235
 
1102
1236
  $ aoox registry push myapp:1.0.0 --force
1103
1237
  ```
1104
1238
 
1105
- _See code: [src/commands/registry/push.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.11/src/commands/registry/push.ts)_
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)_
1106
1240
 
1107
1241
  ## `aoox reinstall`
1108
1242
 
@@ -1132,7 +1266,7 @@ EXAMPLES
1132
1266
  sudo aoox reinstall --yes --terminal-ssh-user root
1133
1267
  ```
1134
1268
 
1135
- _See code: [src/commands/reinstall.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.11/src/commands/reinstall.ts)_
1269
+ _See code: [src/commands/reinstall.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.13/src/commands/reinstall.ts)_
1136
1270
 
1137
1271
  ## `aoox run`
1138
1272
 
@@ -1177,7 +1311,7 @@ EXAMPLES
1177
1311
  $ aoox run --quiet -- npm run dev
1178
1312
  ```
1179
1313
 
1180
- _See code: [src/commands/run.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.11/src/commands/run.ts)_
1314
+ _See code: [src/commands/run.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.13/src/commands/run.ts)_
1181
1315
 
1182
1316
  ## `aoox update`
1183
1317
 
@@ -1199,7 +1333,7 @@ EXAMPLES
1199
1333
  $ aoox update --check
1200
1334
  ```
1201
1335
 
1202
- _See code: [src/commands/update.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.11/src/commands/update.ts)_
1336
+ _See code: [src/commands/update.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.13/src/commands/update.ts)_
1203
1337
 
1204
1338
  ## `aoox update panel`
1205
1339
 
@@ -1224,7 +1358,7 @@ EXAMPLES
1224
1358
  $ aoox update panel --apply
1225
1359
  ```
1226
1360
 
1227
- _See code: [src/commands/update/panel.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.11/src/commands/update/panel.ts)_
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)_
1228
1362
 
1229
1363
  ## `aoox whoami`
1230
1364
 
@@ -1251,7 +1385,7 @@ EXAMPLES
1251
1385
  $ aoox whoami --json
1252
1386
  ```
1253
1387
 
1254
- _See code: [src/commands/whoami.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.11/src/commands/whoami.ts)_
1388
+ _See code: [src/commands/whoami.ts](https://github.com/hideandseeklab/aoox-cli/blob/v0.1.0-alpha.13/src/commands/whoami.ts)_
1255
1389
  <!-- commandsstop -->
1256
1390
 
1257
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
- REGISTRY_INTERNAL_URL: http://host.docker.internal:${REGISTRY_PORT:-5000}
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,8 +106,13 @@ 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:-}
113
+ # Host port the web is published on (same value as the `web` port mapping); only used
114
+ # to tell the owner where to reopen the dashboard after removing the panel domain.
115
+ WEB_PORT: ${WEB_PORT:-3000}
105
116
  STORAGE_PATH: ${STORAGE_PATH:-}
106
117
  # Absolute path, on this host, of the folder holding this file — required
107
118
  # only for Settings -> "Domain panel" (lets the API write
@@ -121,6 +132,9 @@ services:
121
132
  # (<app>-pr<N>.<domain>, needs a wildcard DNS record).
122
133
  WEBHOOK_VERIFY_GITHUB_IP: ${WEBHOOK_VERIFY_GITHUB_IP:-}
123
134
  PREVIEW_DOMAIN: ${PREVIEW_DOMAIN:-}
135
+ # Which proxy hops may set the client IP (X-Forwarded-For). Empty = private networks
136
+ # only (Traefik, the web container); see TRUST_PROXY in .env.dist.example.
137
+ TRUST_PROXY: ${TRUST_PROXY:-}
124
138
  # The api container runs as the unprivileged `node` user; add the gid that
125
139
  # owns the docker socket on the host (stat -c %g /var/run/docker.sock).
126
140
  group_add:
package/bin/dev.js CHANGED
@@ -4,12 +4,18 @@
4
4
  // so importing straight from src/ — instead of duplicating
5
5
  // windows-exit-fix.ts here — is fine.
6
6
  // eslint-disable-next-line n/no-unpublished-import
7
+ import {executeCli} from '../src/lib/interrupt.js'
8
+ // eslint-disable-next-line n/no-unpublished-import
9
+ import {applySystemCa} from '../src/lib/system-ca.js'
10
+ // eslint-disable-next-line n/no-unpublished-import
7
11
  import {applyWindowsExitFix} from '../src/lib/windows-exit-fix.js'
8
12
 
9
13
  // Must run before any command (and any fetch()) — see the doc comment on
10
14
  // applyWindowsExitFix for why.
11
15
  applyWindowsExitFix()
12
16
 
13
- const {execute} = await import('@oclif/core')
17
+ // Trust the OS certificate store too (antivirus HTTPS scanning, corporate proxies).
18
+ // Runs before the first fetch(); opt out with AOOX_SYSTEM_CA=0.
19
+ applySystemCa()
14
20
 
15
- await execute({development: true, dir: import.meta.url})
21
+ await executeCli({development: true, dir: import.meta.url})
package/bin/run.js CHANGED
@@ -1,11 +1,15 @@
1
1
  #!/usr/bin/env node
2
2
 
3
+ import {executeCli} from '../dist/lib/interrupt.js'
4
+ import {applySystemCa} from '../dist/lib/system-ca.js'
3
5
  import {applyWindowsExitFix} from '../dist/lib/windows-exit-fix.js'
4
6
 
5
7
  // Must run before any command (and any fetch()) — see the doc comment on
6
8
  // applyWindowsExitFix for why.
7
9
  applyWindowsExitFix()
8
10
 
9
- const {execute} = await import('@oclif/core')
11
+ // Trust the OS certificate store too (antivirus HTTPS scanning, corporate proxies).
12
+ // Runs before the first fetch(); opt out with AOOX_SYSTEM_CA=0.
13
+ applySystemCa()
10
14
 
11
- await execute({dir: import.meta.url})
15
+ await executeCli({dir: import.meta.url})
@@ -9,6 +9,7 @@ import { imageRefFor } from '../lib/image-ref.js';
9
9
  import { readLink } from '../lib/link.js';
10
10
  import { warnIfOutdated } from '../lib/outdated.js';
11
11
  import { chooseRegistry, localhostRegistryHint } from '../lib/registry-select.js';
12
+ import { stepLine, successLine, warnLine } from '../lib/style.js';
12
13
  /** How often to poll GET /deployments/:id while a deploy is in progress. */
13
14
  const POLL_MS = 1500;
14
15
  export default class Deploy extends Command {
@@ -38,13 +39,13 @@ export default class Deploy extends Command {
38
39
  }
39
40
  throw error;
40
41
  }
41
- await warnIfOutdated((m) => this.warn(m), this.config.version, config);
42
+ await warnIfOutdated((m) => this.logToStderr(warnLine(m)), this.config.version, config);
42
43
  const app = await this.getApplication(config, link.applicationId);
43
44
  const registry = await this.pickRegistry(config, flags.registry);
44
45
  const credentials = await api(config, `/registries/${registry.id}/credentials`);
45
46
  const localHint = localhostRegistryHint(registry.url, config.url);
46
47
  if (localHint)
47
- this.warn(localHint);
48
+ this.logToStderr(warnLine(localHint));
48
49
  const tag = flags.tag ?? deployTag(cwd);
49
50
  const imageRef = imageRefFor({ appName: app.appName, projectName: app.project.name, registryUrl: registry.url, tag });
50
51
  const engine = await dockerEngineStatus();
@@ -52,15 +53,15 @@ export default class Deploy extends Command {
52
53
  const [headline, hint] = dockerUnavailableLines(engine);
53
54
  this.error(headline, { suggestions: [hint] });
54
55
  }
55
- this.log(`==> Build ${imageRef}`);
56
+ this.log(stepLine('Build', imageRef));
56
57
  await dockerInherit(['build', '-t', imageRef, '-f', flags.dockerfile, flags.context], cwd);
57
58
  if (credentials.username && credentials.password) {
58
- this.log(`==> docker login ${registry.url}`);
59
+ this.log(stepLine('docker login', registry.url));
59
60
  await dockerLogin(registry.url, credentials.username, credentials.password, cwd);
60
61
  }
61
- this.log(`==> Push ${imageRef}`);
62
+ this.log(stepLine('Push', imageRef));
62
63
  await dockerInherit(['push', imageRef], cwd);
63
- this.log('==> Updating the application & triggering a deploy');
64
+ this.log(stepLine('Updating the application & triggering a deploy'));
64
65
  await api(config, `/applications/${app.id}`, {
65
66
  body: { imageRef, imageRegistryId: registry.id, sourceType: 'image' },
66
67
  method: 'PATCH',
@@ -81,7 +82,7 @@ export default class Deploy extends Command {
81
82
  printed = dep.logs.length;
82
83
  }
83
84
  if (dep.status === 'success') {
84
- this.log(`Deployed: ${dep.imageRef}`);
85
+ this.log(successLine('Deployed:', dep.imageRef ?? undefined));
85
86
  return;
86
87
  }
87
88
  if (dep.status === 'failed') {
@@ -0,0 +1,16 @@
1
+ import { Command } from '@oclif/core';
2
+ /**
3
+ * Counterpart of `aoox domain set`: calls the panel's `DELETE /instance/domain`,
4
+ * which takes the dashboard and API back to plain IP access and recreates the
5
+ * web/api containers. The reverse proxy and application domains are untouched.
6
+ */
7
+ export default class DomainClear extends Command {
8
+ static description: string;
9
+ static examples: string[];
10
+ static flags: {
11
+ yes: import("@oclif/core/interfaces").BooleanFlag<boolean>;
12
+ token: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
13
+ url: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
14
+ };
15
+ run(): Promise<void>;
16
+ }