The following details how to set up Wallaroo Community Edition using GitHub Codespaces. This provides a quick method of setting up Wallaroo Community Edition with just a few commands. You get the free license from the Wallaroo Community Edition Portal site, and the rest of the process is handled by GitHub and Wallaroo.
From the Wallaroo Community Edition Portal page, follow the registration instructions. If a Wallaroo Community Edition license already exists for this account, enter the same name and email address to retrieve the registration link.
Download the Wallaroo Community Edition license. This provides both the Wallaroo Community Edition license in YAML format and the base64 encoded version. Store both in a secure location. The base64 ended version will be used in this process.
From the License Download page:
From the Create codespace GitHub page for Wallaroo Community, set the following:
When complete, select Create Codespace. Wait until the process is complete - this usually takes about 15 minutes.
To see the installation process in action, use one of the following options:
Control-Shift-P
or Command-Shift-P
(for MacOS systems) and select Codespaces: View Creation Log.Once the entry “Finished configuring codespace” is displayed, the Wallaroo Community Edition installation is complete.
If this is your first login, you will receive an email invitation for the email address connected to this URL with a temporary password. Follow the link provided in the email. If not already logged into GitHub, a prompt will appear for you to login to GitHub to manage the port forwarding required to connect to the Wallaroo Community Edition instance through your browser.
To login to your new Wallaroo instance, enter the email address and temporary password associated with the license. Enter a new password twice to set a new permanent password, and you will be logged into the Wallaroo Community Edition instance.
Subsequent logins will are performed through the same URL.
To start and stop the Wallaroo Community Edition codespace:
F1
and select Stop Current Codespace.See Setting your timeout period for GitHub Codespaces for information on timeout settings.
When Wallaroo Community Edition is installed through GitHub Codespaces, the base64 hash of the Wallaroo license used in the installation process is stored in GitHub.
To update this license:
Select your GitHub user profile, then Settings.
Select Codespaces, then Codespaces secrets. The Wallaroo Community Edition license is listed as WALLAROO_LICENSE. Use Update to update the license or Delete to remove if it is no longer needed.
To provide for multiple users, the following ports must be set from private to public. This step is not required for users who will be the only one accessing Wallaroo Community Edition though their codespace.
To update the network settings:
Control-Shift-P
or Command-Shift-P
(for MacOS systems) and select View: Toggle Terminal.