Skip to content

Commit 3cd10f3

Browse files
committed
Hint at upcoming Auto Enrollment
Signed-off-by: Alex Ellis (OpenFaaS Ltd) <[email protected]>
1 parent 4aca9dd commit 3cd10f3

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

docs/install-agent.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,35 @@ Make sure you've read the [Actuated EULA](https://github.com/self-actuated/actua
2121

2222
If you missed it in the "Provision a Server" page, we recommend you use Ubuntu 22.04 as the host operating system on your Server.
2323

24+
## Coming soon: Auto Enrollment
25+
26+
We're working on a feature to make setup quicker and easier:
27+
28+
* No need to reach out to us about new servers - they enroll themselves via API
29+
* No more DNS records to manage, or Let's Encrypt
30+
* Fully automated setup with a single bash script - for userdata, cloud-init, or manual installs via SSH
31+
32+
You'll need to obtain an enrollment token from us to use this feature.
33+
34+
Example to paste into userdata (or manually via SSH):
35+
36+
```bash
37+
#!/bin/bash
38+
39+
curl -LSsf https://get.actuated.com | LICENSE="" \
40+
DOCKER_USERNAME="" \
41+
DOCKER_PASSWORD="" \
42+
HOME="/root" bash -
43+
```
44+
45+
* `LICENSE` - the key you purchased for actuated
46+
* `DOCKER_USERNAME` and `DOCKER_PASSWORD` - your Docker Hub credentials for the pull-through cache - leave these empty to cache with anonymous pulls
47+
* `HOME` - the home directory of the user running the script - this is required during userdata since HOME is usually an unset variable.
48+
49+
The installation will guess the best place to store VM snapshots, and if a space disk or partition is found, it will be wiped and formatted.
50+
51+
If the script doesn't find any valid storage, it will provision a loopback file instead which is fine for basic testing. You can specify a specific disk or partition by setting the `VM_DEV` environment variable.
52+
2453
## Install the Actuated Agent
2554

2655
!!! info "Do you want a free, expert installation?"

0 commit comments

Comments
 (0)