Miraheze lets you use a custom domain for your wiki. Instead of having to use mywiki.miraheze.org (a subdomain of miraheze.org), you can use your own domain (e.g., mywiki.com, wiki.domain.com, etc.). Read the steps below for more information.

Steps

Setting up a custom domain is as easy as following 3 steps:

  1. Get a domain.
    • To set up a custom domain, you will need to get a domain. There are many reputable registrars such as Namecheap where you can purchase a domain. Don't want to pay money for a domain? Click here for free domain services.
  2. Point it to Miraheze.
    A crude flowchart. A green box named "your domain registrar", with an arrow titled "nameserver settings" pointing to the next box named "Cloudflare DNS". This box has an arrow titled "CNAME record" and points to the final box, titled "Miraheze hosting".
    Conceptual overview of how one sets up a custom domain to point to Miraheze.
    • Once you have a domain, you'll need to point it to Miraheze. You can set a CNAME record for the subdomain you want your wiki on pointing to cf-lb.miraheze.org. Please note that currently, to use a root domain (i.e domain.com instead of subdomain.domain.com), you will need to setup your domain with Cloudflare DNS. The free plan should work fine for this purpose.
    • Cloudflare users must disable proxying when creating the CNAME record. See the note below for details.
    • Once you've done the steps above. In the form, you only need to provide your wiki's current subdomain and your desired domain.
When you first point your domain, you will see a Cloudflare error page, which in some cases may say "Cross-user banned". This is completely expected, and just means that we haven't setup your domain yet.
Custom domain request form (via RequestCustomDomain)
  1. Create a redirect (optional).
    • By default, user can reach the wiki through both the original domain (somedomain.miraheze.org) and the custom domain. It is possible to automatically redirect pages from the original domain to the custom domain by filing a request on Phorge. Redirecting comes with some advantages and disadvantages detailed below.
    • Advantages. Search engines often continue to index and prioritize the original domain, so a redirect would signal to the search engine that the site has moved. Additionally, Miraheze's infrastructure is designed to ensure that the custom domain functions properly, and users may encounter bugs at the original domain. Redirecting to the custom domain will result in a uniform experience among readers.
    • Disadvantages. If the custom domain is misconfigured or has expired, then the wiki would be completely down. If a redirect does not exist, users can still visit the original domain, which serves as a backup.

Need help with any of the steps or have a question? Ask the community noticeboard for help.

Note for Cloudflare users

Cloudflare users must turn off Cloudflare's DDoS/Origin IP protection system/workers.

This is not negotiable.

With it enabled, Miraheze cannot process Custom Domain requests.

We already proxy traffic through Cloudflare, and the domain will not activate on our end when there are two layers of proxying.

Follow the steps to find out how to disable Cloudflare DDoS/Origin IP protection system (assuming you're using the dash.cloudflare.com dashboard).

  1. Go to dash.cloudflare.com
  2. Click your domain in the dashboard.
  3. Go to "DNS".
  4. Add CNAME entry to cf-lb.miraheze.org. The cloud with an arrow must be grey. If it is yellow, click it to make it grey.
  5. Click "Add Record". The result has to look like the last image.

If you are done with this, continue back on the steps above.

 Not following the rules above will result in your custom domain being removed immediately and further action being taken if necessary. In case of any doubt, feel free to contact us at tech@miraheze.org or ask on the Phorge task you create.

Cloudflare dashboard
Cloudflare dashboard
Domain section.
Domain section
Your entry should look like this!
Your entry should look like this!

FAQ

What services can I use to get a free domain?

 FreeDNS users, and free domain providers in general, may find themselves flagged automatically by security vendors. They may need to be manually cleared with major internet security providers in order to work as expected. See diff.

If you don't wish to pay for a domain of your own, there are services that offer free domains and subdomains which you can use instead. Remember that all Miraheze wikis automatically get a free subdomain on miraheze.org and search engine ranking benefits from Miraheze's domain authority.

Free (sub)domain providers

FreeDNS example

 As of October 7, 2024, if you are using FreeDNS, the addition of CNAME records to subdomains has been disabled by default for all new accounts; you will most likely have to request that it be enabled for your account beforehand.

  • Sign up with FreeDNS and log in.
  • On the left side, click 'Registry' to select a domain (e.g., mine.bz). This will take you to a small form to fill in.
  • Please avoid using a us.to domain, as it is impossible to generate a Let's Encrypt certificate for these.
  • Add a subdomain (keep trying until you find an available one, e.g., mario).
  • Select 'CNAME' for the type.
  • In the destination field, enter cf-lb.miraheze.org, solve the captcha, and click the save button.
FreeDNS example setup
FreeDNS example setup.

Then follow the above step 3. Make the request!.

How do I set up my domain with NameCheap?

Go to domain settings, and locate the Nameservers setting. Change it to Custom DNS, and enter the nameservers assigned to you by Cloudflare. (Note that the CNAME settings are done in Cloudflare, and not in the NameCheap settings!)

NameCheap example setup
NameCheap example setup.

Can I change the URL structure?

You can request to change it at Steward requests/Restricted changes. For example, if your wiki is example.miraheze.org and its main page is called "Welcome", then the URL can either be https://example.miraheze.org/wiki/Welcome or https://example.miraheze.org/Welcome (note the /wiki/ piece). You can also choose to have your wiki main page to be served at absolute domain root (https://example.miraheze.org).

See also