Yelken Docs

Appearance

Domains & Routes ​

Domain is a resource that belongs to a project. You can use your custom domain in your projects and direct incoming traffic to your services by defining routes. Yelken will automatically obtain SSL certificates for your domains from Let's Encrypt and provide secure TLS connections for your services.

To view all domains and routes of a project:

  • Open a project by choosing it in Projects page,
  • Use Domains & Routes link accessible inside the sidebar located at left.

Adding Domain ​

You can simply add your own domain by using Add Domain button inside the Domains & Routes page. In the opened modal, you need to specify your domain and use Add button to add it.

Once you add your domain, it will be displayed in its own section with a warning indicating that you need to verify that you are the owner of this domain name. This is required since any other user in Yelken can claim your domain name and use it for their website. Additionally, your domain also needs to point to our servers for your website to work.

To achive these two, you need to create necessary DNS records on your DNS nameserver platform. By using Verify Domain button, you can view DNS records you need to create and check that they exist.

Managing Routes ​

Routes are resources that are part of a domain and help you direct incoming traffic for a domain to the port of a service in your project. You can add a route to a domain by using Add Route button located next to the domain. In the opened modal, you need to provide a few information:

  1. Environment: choose the environment your services running in.
  2. Service: choose the service you want to send the incoming traffic.
  3. Port: choose which port you want to send the incoming traffic.
  4. Route Protocol: the protocol you want to have for route. Currently only HTTP protocol is supported.
  5. Path (optional): specify a path to filter HTTP request that will be directed by this route. Paths of routes must be unique for a domain.
  6. Finally, use Add button to add your route.

Once you add the route, Yelken will update the infrastructure to apply your changes. Changes may take some time to get fully applied.

If you want to remove a route from a domain, simply use button with X icon located next to the route.

Deleting Domain ​

Inside the Domains & Routes page, you can use Delete button located next to the domain you want to delete. It will require a confirmation from you by asking you to enter domain name.

⚠️ Please be careful

All routes belonging to this domain will be deleted immediately once you confirm the deletion. There is no going back after confirming the deletion!