User Onboarding

Accepting user invitation #

• The user will receive an email invitation. Click Check out DevZero this will redirect the user to the sign-up page

Invitation email

• Another email will be sent with the access code

• Enter the access code in the sign-up screen, and click Continue . This will take you to the DevZero dashboard for your organization

Sign Up

• DevZero dashboard will look like below

DevZero Dashboard

Connect your GitHub account #

• Click on the arrow next to Connect your GitHub account OR Navigate to Personal Settings -> Git Integrations -> Connect to source code on GitHub
• Enter the username and password for your GitHub account and click Sign in

• If you have set up two-factor authentication, complete the process
• Click Authorize to grant the DevZero App access to your repositories on Github. This will enable you to clone source code in the dev boxes

• After successfully connecting to GitHub, you will see the following screen

Set up Public SSH Keys #

• Click on the Settings icon (located at the top right corner) and navigate to the SSH Keys section or follow this link

• Click Add SSH Key and follow the wizard to manually create an SSH key on your local machine

• After creating an SSH key and copying it by following steps 1 and 2 above, enter a name for the key and paste the SSH key into the "Public SSH Key" text box
• Click on Add SSH Key. You should be able to create an SSH Key successfully

• Click on Sync Github Keys to synchronize your public keys on GitHub (if you have any) with DevZero

Checkout Template #

• Go to the dashboard by clicking <- Your Environments or follow the link
• The Environments section on the Dashboard will have templates for your Organization

• If there are no templates in the Environments section, create a template by following the tutorial located here

Launch an environment for development #

• Click on the Launch button to create or get a new development environment

• A development environment will start building and will be available for you to use in some time

• This guide provides more details on launching a machine using both the dashboard and a CLI tool

Connect to an Environment #

• Once the development environment is ready, you will be able to: All the above options are available in the dropdown
  • Open in VS Code
  • Open in a Web Browser
  • SSH into the machine

All the above options are available in the dropdown

• To Open in VS Code, you must have VS Code installed on your computer. If you haven't already installed VS Code, you can download it from here
• To Open in a Web Browser, click the button and start working on your project in the browser

• To SSH into the development environment, copy the SSH command from the drop-down and paste it into your computer's terminal. Since you have already configured SSH keys, this should work without any issues.

• To connect to a machine using the command-line interface (CLI) tool, follow this guide

Using Eclipse as IDE #

Follow the instructions in this guide to set up Eclipse for remote environment development

VS Code Extension #

DevZero offers a VS Code extension to launch and connect to your development environment

• In your VS Code IDE, open the extensions section, search for DevZero extension, and click install

• Once installed, you will see the extension on the left side of the VS Code IDE, click on the extension and click Sign In to sign into DevZero

• On Sign In, you should be able to see the your Available Environments and launch a development environment from the extension

• Once you click Launch you can click, View In Launch Pad to see the environment being built

• Once the environment is ready, click Start Coding to open the project in VS Code

Personal Settings #

• Login to https://console.devzero.io. Click the gear icon, ⚙, in upper right

Profile Info #

• Under “Personal Settings”, click Profile Info. Set the First and Last name by clicking Edit Info button

• Enter your First and Last name, user name, select default region and Click Save Changes

• Default Region is the region the you want your development environment to be launched in

Customizations #

• Under “Personal Settings”, click Customizations. Within this section, the “Personal Policy” allows you to specify user-specific packages or scripts that you want to execute on every development environment that you acquire

Here is an example of a software policy to install packages such as jq, zsh, and awscli. Additionally, there is a script policy to set up git and install more packages like tmux and protobuf

Dotfile Repo #

• To set up dot files in your development environments, go to “Personal Settings” and click on Dotfile Repo. You can provide a URL to a public repository that contains dotfiles to customize your environment. Example URL can look like: https://github.com/user/reponame.git

• For more details on setting up customizations and dotfiles, please refer to this guide

User Environment Variables #

• To set up environment variables in your development environment, go to “Personal Settings” and click on User Environment Variables
• Add environment variables that will be applied to every machine you create. Stored securely, then decrypted to be available in your runtime