Skip to content

Latest commit

 

History

History

authproxy

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
config
config
 
 
src
src
 
 
.eslintrc.cjs
.eslintrc.cjs
 
 
Dockerfile
Dockerfile
 
 
README.md
README.md
 
 
docker-compose.yml
docker-compose.yml
 
 
package.json
package.json
 
 
tsconfig.json
tsconfig.json
 
 

README.md

@tinyburg/authproxy

You can use this proxy server to set the proper authentication headers for you. IMPORTANT: this server will not function properly if you run it on your own.

Notes

  1. The proxy is rate-limited, you will only be able to send 5 requests every 2 mins by default
  2. You must set the "useProxy" flag in the tinyburg library if you wish to enable the auth proxy
  3. This proxy will deny requests for certain scopes. For examples, it will not process any enter raffle, new user, or upload save requests

Higher rate limits and privileged scopes can be granted to users through API keys. There is no dashboard for managing api keys as of right now. To obtain an api key, email [email protected]. The header of the email should be "Tinyburg Authproxy API Key Request" and explain in the body why you are requesting an api key and how you plan to use it. API keys can be revoked at any time and for any reason.