Accessing Deployments through Generated URLs
When you create a new deployment, Epycbyte will automatically generate a unique URL which you can use to access that particular deployment.
Table of Contents
- When you create a new deployment
- Viewing generated URLs
- URL Components
- Generated from Git
- Generated with Epycbyte CLI
- Truncation
- Anti-phishing protection
When you create a new deployment
When you create a new deployment in either a preview or production environment, Epycbyte will automatically generate a unique URL in order for you to access that deployment. You can use this URL to access a particular deployment for as long as your set deployment retention policy allows.
This URL is publicly accessible by default, but you can configure it to be private using deployment protection.
Viewing generated URLs
You can access these automatically generated URLs in the following ways:
- On the command line when the build has completed.
- When using Git, you can access either a URL for the branch or for each commit. To learn more, see Generated from Git.
- Under the Project's Overview and Deployments tabs.
URL Components
Generated URLs are comprised of several different pieces of data associated with the underlying deployment. Varying combinations of the following information may be used to generate a URL:
Created when: The name of the Project that contains the deploymentGit branch,Git commit,CLI: A unique hash of 9 randomly generated numbers and lettersGit commit: The slug (not the name) of the account or team that contains the project/deploymentGit branch,Git commit,CLI: The name of the Git branch for which the deployment was created
Generated from Git
When working with Git, Epycbyte will automatically generate a URL for the following:
- The commit: This URL will always show you a preview of changes from that specific commit. This is useful for sharing a specific version of your project at a point in time.
- url-structure
<project-name>-<unique-hash>-<scope-slug>.epycbyte.app - The branch: The URL generated from a Git branch will always show you the most recent changes for the branch and won't change if you push new commits to the branch. For this reason, this format is ideal for sharing with team members during your review process.
- url-structure
<project-name>-git-<branch-name>-<scope-slug>.epycbyte.app
Generated with Epycbyte CLI
To access the URL for a successful deployment from Epycbyte CLI, you can save the standard output of the deploy command. The generated URL will have the following structure:
- url-structure
<project-name>-<scope-slug>.epycbyte.app - If the deployment is created on a Team, you can also use the URL specific to the deployment's author.
- url-structure
<project-name>-<author-name>-<scope-slug>.epycbyte.app
Truncation
If more than 63 characters are present before the .epycbyte.app suffix (or the respective Preview Deployment Suffix) for a generated URL, they will be truncated.
Anti-phishing protection
If your <project-name> resembles a regular web domain, it may be shortened to avoid that resemblance. For example, www-company-com would be changed to just company. This is done to prevent an accidental trigger of anti-phishing protection built into web browsers that protect the user from visiting domains that look roughly like other domains they visit.
Preview Deployment Suffix
Preview Deployment Suffix is available on Pro and Enterprise plans. Preview Deployment Suffixes allow you to customize the URL of a preview deployment by replacing the default epycbyte.app suffix with a custom domain of your choice. To learn more, see the Preview Deployment Suffix documentation.