11min

Spaces and hosting

You want to publish documentation for your product, and you want to be available at your domain: docs.yourdomain.com.

Usually, you would reach out to the engineering team to build it and host it somewhere on your servers. 

Archbee provides a more straightforward and hands-free solution to build a documentation website without requiring development resources.

Archbee's spaces can be set as public, and they can be hosted on your domain. You can customize how your space will look with auto-renewable SSL certificates and guaranteed uptime as part of our SLA. Our system will host your content on your domain through AWS's CloudFront CDN to be super fast and reliable.

How to set up a docs site

1. Click on the space you want to publish

Look for the gear icon ⚙️ and click to get the Space Settings. You will find multiple options.

2. Options for Public Spaces

Toggle the option for Public. Now your space is accesable for visitors that have the link.

Decide if you want to be indexable by search engines or not. If you don't want the documentation to be found, toggle off Indexable by search engines.

Initially you will have a staging URL, that can be found under For public space section.

You can use this URL to share the space to others, or add a custom domain.

Document image

3. Click on Custom Domain tab

Document image

4. Follow all the steps to add a domain

Step 1:  Add CNAME host.archbee.io to your desired subdomain (e.g docs.yourdomain.com) by visiting your DNS provider or registrar.

Step 2:  Wait the DNS to propagate (takes from a few minutes up to 24 hours).

Step 3:  Set space to public (not necesary if you already set it public in the General tab).

Step 4:  Set your desired subdomain here.

Step 5:  Optionally set a URL path, to have multiple spaces on 1 domain.

Step 6:  Publish the space with the big blue button on the bottom right.

Step 7:  Go to you docs.yourdomain.com to trigger creation of SSL certificates.

Document image

On Step 5, you can add a URL path so that you can publish multiple spaces on the same domain. This works if you have multiple products or if you have multi-language documentation.

You will set up a space with the custom domain: https://docs.archbee.io And the next ones will have the URL path similar to this:

When a new domain is configured, an automated publish will be triggered!

5. Exit the Space Settings windows.

Document image

6. Publish the space

When you add a custom domain, you can click on Publish to finish the setup.



Updated 30 Jun 2022
Did this page help you?
Yes
No