Setting up your site for proxying

You can set up a reverse proxy from your server to your Eager documentation site. For example, the site you're currently reading is proxied from our eager.app site from the /docs path (the site you're currently browsing).

Prerequisites:

• Knowledge on modifying and setting up web servers (eg. Nginx or Apache)
• Root or sudo access to your main site

Note that this is an advance set up, and your existing site may not allow you to accomplish this. In this case, we recommend that you set up a custom subdomain to host your documentation site.

Proxy Site Settings:

To get started, you will need to set your site to be the origin server for a reverse proxy request. Go to the dashboard and select the site you want to modify, and click on Settings:

Next, specify that the site should be accessed via Proxy through your webserver:

You will need to specify the URL where you'll be proxying. This will be the "root" page of the documentation site on your proxied path.

For example, on the site you're reading now, it is https://eager.app/docs.

Click Save to persist the changes.

Setting up your proxy on your webserver

Next, you will need to copy the proxy key that's shown. The proxy key helps authenticate your proxy requests to our servers when your webserver makes its proxy requests.

You will define this as part of a proxy header. For example, we're using Nginx on our backend. And so, when we define a proxy path, we do it like so:

location /docs/ {  
     proxy_pass https://<subdomain URL>;  
     proxy_set_header EagerProxyKey proxy_key_here;
}

Remember to replace "proxy_key_here" with the actual proxy key.

Note that in the above screenshot, our regular subdomain to the site is at https://documentation.eager.page. As a result, our proxy pass address is https://documentation.eager.app/.