On April 1, 2021, we are moving all of our QuotaGuard Support Documentation to
https://quotaguard.github.io/qg-docs/
Please Update Your Support Bookmarks
Documentation for this article will be maintained at
https://quotaguard.github.io/qg-docs/quickstart-ruby
Please click on the above link to ensure you are reading
the most recent and updated documentation.
We suggest you go with the SOCKS proxy using our QGTunnel software.
Here are the setup instructions to get you started.
Download QGTunnel into the root of your project
curl https://s3.amazonaws.com/quotaguard/qgtunnel-latest.tar.gz | tar xz
Log in to our dashboard and set up the tunnel
Direct/Azure/Render/AWS users should visit https://www.quotaguard.com/users/sign_in to sign in to your account.
Heroku Users can use the Heroku CLI you can log into our dashboard with the following command:
heroku addons:open quotaguardstatic
Or if you prefer, you can log in from the Heroku dashboard by clicking on QuotaGuard Static on the resources tab of your application.
Once you are logged into our dashboard, in the top-right menu, go to Setup. On the left, click Tunnel, then Create Tunnel.
Remote Destination: tcp://hostname.for.your.server.com:22
Local Port: 2222
Transparent: true
Encrypted: false
This setup assumes that the remote SFTP server is located at hostname.for.your.server.com and is listening on port 22. This is usually the default port.
The Local Port is the port number that QGTunnel will listen on. In this example, we set it to 2222, because port 22 is probably in use on the localhost and it is also in the reserved port range (0-1023).
Transparent mode allows QGTunnel to override the DNS for hostname.for.your.server.com to 127.0.0.1, which redirects traffic to the QGTunnel software. This means you can connect to either hostname.for.your.server.com or 127.0.0.1 to connect through the tunnel.
Encrypted mode is disabled because SFTP is already encrypted and you will not want to waste your time setting up additional end-to-end encryption.
Change your code to connect through the tunnel
With transparent mode, you will only have to change to connect to port 2222 instead of 22. You can also connect to 127.0.0.1:2222.
Without transparent mode, you will want to connect to 127.0.0.1:2222.
Change your startup code
Change the code that starts up your application. In many platforms, to include Heroku, this is done with a Procfile. Basically, you just need to prepend your startup code with "bin/qgtunnel".
So for a Procfile that was previously:
web: your-application your arguments
you would now want:
web: bin/qgtunnel your-application your arguments
Heroku Users : If you do not have a Procfile, then Heroku is using a default setup in place of the Procfile based on the framework or language you are using.
You can usually find this information on the Overview tab of the application in Heroku’s dashboard. It is usually under the heading “Dyno information”.
Setup the environment variable QUOTAGUARDSTATIC_URL to be equal to your Connection URL in the Setup page of our dashboard
If you added us from a cloud provider (Azure, CloudFoundry, Heroku, Render, IBM Cloud, Pivotal, etc) then this is usually done for you.
Please note that QGTunnel handles converting the HTTP URL and port to the SOCKS5 URL and port. So either of the connection URLs is fine.
Commit and push your code
Be sure that the file bin/qgtunnel is added to your repository.
If you are using transparent mode, be sure that vendor/nss_wrapper/libnss_wrapper.so is also added to your
repository.
If you have problems
Enable the environment variable QGTUNNEL_DEBUG=true and then restart your application while watching the logs. Send QuotaGuard Support any information in the logs.
Please redact any sensitive information, including your QuotaGuard connection URL.
VERY IMPORTANT
After you get everything working, we suggest you download your QGTunnel configuration from our dashboard as a .qgtunnel file and put that in the root of your project.
This keeps your project from not relying on our website during startup. Our website might be down for maintenance and your application would fail because it can not find your configuration file.
If you have questions, or if this solution doesn’t work or fit your use case, please reach out to us at Support so we can help figure it out with you.