Quickstart

Please take into account that this article is a draft and is not yet finished

Step 0: Pre-requisite

oauthd is a solution based on node.js that enables you to set up and run your own stand-alone, completely free, web Background API Server.

Pre-requisite to the oauthd installation are:

• Node.js
• Redis

The default configuration of oauthd use the Redis default configuration. You can check the configuration section to learn more about configuration. However, for a quickstart, you can just check that your Redis is working by following this redis quickstart tutorial.

Another dependencies for oauthd is grunt-cli which is just a npm package you will need to install globally, by executing the following command:

$ (sudo) npm install -g grunt-cli

Step 1: Install oauthd

You should install oauthd from npm, by executing the following command:

$ (sudo) npm install -g oauthd

Once you've installed the oauthd npm package globally, you will have the oauthd command available in your shell. This command allows you to create new oauthd instances, start them, and manage their plugins.

Run the following command, to make sure the oauthd command is available in your shell:

$ oauthd -v

Having difficulties or running into errors or problems? Check the oauthd installation section.

Step 2: Create an instance

Go into a folder where you want to create your oauthd instance and run the following command:

$ oauthd init

Follow the prompt instructions. It will guide you in the instance creation. You need to answer 'Y' or just press enter when the prompt ask you:

oauthd> Do you want to install default plugins?  (Y|n)>  (Y)

This will automatically cloned and activated the default plugins and then run npm install && grunt in your instance's folder.

Once all is done, you can go in your oauthd instance folder.

Having difficulties or running into errors or problems? Check the oauthd cli section.

Step 3: Start the instance

To start the instance, just run the following command:

$ cd myinstance && oauthd start

You should see something like this in your shell:

Initializing plugins engine
Loading auth
Loading request
Loading slashme
Loading statistics
Loading front
oauthd start server
oauthd listening at http://0.0.0.0:6284 for http://localhost:6284
Server is ready (load time: 0.9s)

Once the instance server is started, you can access the web interface to create your first app and configure its API providers.

Go to the following url in your favorite browser: http://localhost:6284/

Step 4: Use oauthd