Website logo
⌘
K
Book a DemoSign Up ->
🌐
User & Dev Guide
💼
Careers
💻
Demo
GitHub Example
🚀GETTING STARTED
👋Welcome to Archbee 🤓
Learn the basics
How to get started
📝EDITOR
📃DOCUMENTS
🗃️SPACES
🌎HOSTED SPACES
🔃PUBLIC API
GET
Get document
POST
Update / Create document
DELETE
Delete document
GET
Search document
☕ORGANIZATIONS
📦IMPORT & EXPORT
🔌INTEGRATIONS
📥GUIDES
➿MISC
🙋Q&A
Docs powered by Archbee
HOSTED SPACES

Hosting Spaces on a sub folder

The default way to host documentation with Archbee is on your custom domain, e.g docs.example.com. To make docs available at your main domain at a sub folder like https://example.com/docs, you will need access to your webservers to be able to proxy requests to our systems.

You will need to setup a default custom domain anyway, and then proxy to it from your main domain. We will take care that Google doesn't see it as duplicate by signalling it through a custom canonical tag.

Step 1: enter the optional proxy like in the picture below.

Custom Proxy
Custom Proxy


While you're here, please make sure the URL path at Step 5, is the same one you set below in your webserver config.

Step 2: Here are a couple of samples from popular webservers on how to config it so that the proxying system works.

Nginx Server Config

Text
location /docs {
    proxy_ssl_server_name on;
    proxy_pass https://subdomain.example.com/docs
    proxy_set_header Host subdomain.example.com;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header X-Forwarded-Proto $scheme;
    proxy_set_header "requested-by" "proxy";
}


Apache Server Config

1.Ensure the following modules are installed and enabled:

Text
sudo a2enmod proxy
sudo a2enmod proxy_balancer
sudo a2enmod proxy_http


2.Add the following to the site configuration file under /etc/apache2/sites-available

For example: 000-default.conf

JS
SSLProxyEngine on
ProxyPass "/docs" "https://subdomain.example.com/docs"
ProxyPassReverse "/docs"  "https://subdomain.example.com/docs"


Our full domain test working config looks something like:

Text
<VirtualHost *:80>
   ServerName example.com
   DocumentRoot "/app"
   <Directory "/app">
       Options Indexes FollowSymLinks
       AllowOverride All
       Require all granted
   </Directory>

   SSLProxyEngine on
   ProxyPass "/docs"  "https://subdomain.example.com/docs
   ProxyPassReverse "/docs"  "https://subdomain.example.com/docs"
</VirtualHost>


3.Restart the Apache server:

For example, If you are using Apache on Linux:

Text
$ sudo service apache2 restart




Updated 02 Nov 2023
Did this page help you?
PREVIOUS
Hosting Spaces on a custom domain
NEXT
Public Access Controls
Docs powered by Archbee
TABLE OF CONTENTS
Step 1: enter the optional proxy like in the picture below.
Step 2: Here are a couple of samples from popular webservers on how to config it so that the proxying system works.
Nginx Server Config
Apache Server Config
Docs powered by Archbee