Quickstart Guide

Let’s get your first service online.

Prerequisites / Assumptions

• Your service is already containerised.
• Docker cli is installed locally.

1. Setup your account

If you haven’t already, sign up for an account with EdgeOrb and create your first project. The project will contain all of the resources to run your services, and is the access control boundarys.

2. Upload your container image

Before you can deploy your service, you need to upload it to the EdgeOrb platform. Follow this guide to authenticate and upload your container image to the EdgeOrb platform.

https://www.edgeorb.com/docs/registry-uploading-image

3. Create your service

Now that you’ve uploaded your container image, we’re ready to deploy your service. Under the services tab of your project, click on Create Project.

Fill in all of the details, and add any network ports that your services expose. If you need to configure your service, you can add in environment variables now.

Click on Create Service, and an instance of your service will be deployed. You will be redirected to the page for your service.

Within a few minutes, you should see that the instance of your service is now healthy in ‘Running’ status.

Congratulations! You have now deployed your service to EdgeOrb.

4. Expose your service to the internet

Your service is now running, you just need to expose it to the world. Services are exposed through Endpoints, which act as a gateway between inbound requests to your services.

Endpoints can be created under a unique edgeorb.net domain, or with a custom domain - free of charge.

Under the endpoints page, create a new endpoint and select your service and target port. For the purposes of this quickstart, set the Domain Type to EdgeOrb domain.

Once created, you’ll then be given a domain such as the following which routes traffic to your service!

https://yph20-2j42l.edgeorb.net/

Congratulations, you’ve now completed the quickstart, deployed your first service and exposed it to the world!