Start typing to search...
Docs
Publishing and maintaining templates
Using custom domains
Search

Using custom domains

When you publish a Koji, it’s automatically assigned a permalink, based on your user name, that lives on the withkoji.com domain. For example: withkoji.com/~johnsmith789/my-video-game. You have the option of additionally serving your Koji at a custom domain. This option can be helpful if you already own a domain that ties into your marketing strategy, or if you want to create a URL that is easier to identify or verbalize.

Koji has several root domains that you can use at no cost, including:

  • withkoji.com

  • koji.sh

  • koji.game

You can create a custom domain by appending a Koji root domain to a subdomain of your choosing. For example, if you append ".koji.game" to "myvideogame", your custom domain name will be myvideogame.koji.game.

You can also use a domain name that you purchase from somewhere like Google Domains or Namecheap. Then you can make your domain name almost anything you want it to be. For example: thenextgreatvideogame.com.

Note
You can assign only one Koji subdomain to a Koji. If you’ve already assigned a subdomain and you want to change it, follow the steps for releasing a domain. Then you can assign the new one. You can assign as many domains as you want to a Koji if they are domains you own.

Using a subdomain with a Koji root domain

  1. Open the Koji and click the Koji button.

  2. Go to Manage this Koji > Open Creator Dashboard > Custom Domains.

  3. Click New.

  4. Select Subdomain.

  5. Click Next.

  6. Select a root domain.

  7. Enter the subdomain.

  8. Click Save. If the domain name you chose is already taken, "That domain is not available" will be displayed. If the domain name is available, the complete domain name will be displayed.

  9. Click the domain name. You should see a message verifying that your custom domain has been successfully assigned to the Koji.

  10. Click Open to go to the new URL. Your Koji should be displayed.

Note
Custom domains that use a Koji root domain automatically manage HTTPS termination. This means that your Koji’s traffic is secured with HTTPS, but your application itself does not require any special configuration, like listening on both ports 80 and 443, serving certificates and managing certificate lifecycle and renewal, and dealing with mixed-security content.

Using a domain you own

If you buy your own domain name from somewhere like Google Domains or Namecheap, you can easily configure that domain to serve your Koji. Simply register your domain in your project, and then use your domain provider’s management tools to configure the appropriate DNS records.

Registering your domain in your project

  1. Open the Koji and click the Koji button.

  2. Go to Manage this Koji > Open Creator Dashboard > Custom Domains.

  3. Click New.

  4. Select A domain you own.

  5. Click Next.

  6. Enter your complete domain name.

  7. Click Save. The domain name should be displayed.

  8. Click the domain name. You should see a message verifying that your custom domain has been successfully assigned to the Koji.

  9. Follow the steps for configuring DNS records.

  10. Click Open to go to the new URL. Your Koji should be displayed.

Configuring DNS records

If you want to host your Koji on a subdomain of your custom domain name (for example, www.mycustomdomain.com or game.mycustomdomain.com), you will need to use your domain provider’s tools to add a CNAME record for that subdomain (www or game) that points to cnames.withkoji.com.

If you want your Koji to be served from the root domain name (mycustomdomain.com), you need to add an A record for the domain’s root that maps it to Koji’s IP block:

151.101.1.78
151.101.65.78
151.101.129.78
151.101.193.78

If you are configuring a root domain via A records, it is also recommended to configure AAAA records to support IPv6. Koji’s IPv6 block is:

2a04:4e42::334
2a04:4e42:200::334
2a04:4e42:400::334
2a04:4e42:600::334
2a04:4e42:800::334
2a04:4e42:a00::334
2a04:4e42:c00::334
2a04:4e42:e00::334

Different domain providers have different tools for managing DNS records, and some of those tools are more complex than others. If you have questions about how to configure your domain’s DNS records, please connect with us on Discord and someone will be happy to help.

Releasing a domain

  1. Open the Koji and click the Koji button.

  2. Go to Manage this Koji > Open Creator Dashboard > Custom Domains.

  3. Click the domain name you want to release.

  4. Click Release domain.

  5. Click Yes, release.