1) Install SuperTokens (only for self hosting)
Sign up, and go to the on premises dashboard to download the SuperTokens zip file. Once downloaded, extract the zip and run the install commands.
The install command takes the following options:
# sudo is required so that the supertokens
# command can be added to your PATH variable.
sudo ./install [--path=path location] [--with-source]
./install [--path=path location] [--with-source]
Rem run as an Administrator. This is required so that the supertokens
Rem command can be added to your PATH.
install.bat [--path=path location] [--with-source]
--path=path location: (Optional) Specify the relative or absolute installation path for SuperTokens.
--with-source: (Optional) If this is set, then all third party dependencies will be installed along with their source. This option has no affect on the execution of SuperTokens.
2) Start SuperTokens (only for self hosting)
Running the following command will start the service. SuperTokens will use an in-memory database if you do not provide the relevant database config values to it.
Learn more about the CLI here.
3) Integrate into your app
- Go to the Backend SDK Integration section to see documentation for integrating SuperTokens with your backend APIs
- Go to the Frontend SDK Integration section to see documentation for integrating SuperTokens with your frontend clients.
Connecting to your database (only for self hosting)
Please visit the relevant database page under the Database Setup section
Manage license keys (only for self hosting)
Go to the About License Keys section to learn about how you can manage license keys.