Installation
1) Install SuperTokens
To get started with SuperTokens, you first need to install and run the SuperTokens core. If you want to use our Docker image, please go to the Installation With Docker section.
Once downloaded, extract the zip file and run the install commands.
cd supertokens
sudo ./install [--path=path location] [--with-source]
cd supertokens
./install [--path=path location] [--with-source]
Rem run as an Administrator
cd supertokens
install.bat [--path=path location] [--with-source]
--path=path location: Specify the relative or absolute installation path for SuperTokens. If not provided, the installation path will be as follows:- Linux:
/usr/lib/supertokens/ - Mac:
/usr/local/etc/supertokens/ - Windows:
C:\Program Files\supertokens\
- Linux:
--with-source: 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.
After installation, you can safely delete the downloaded zip and the extracted folder.
2) Configure SuperTokens
Before you can start SuperTokens, please set the relevant configuration options.
3) Setup database
Please visit the relevant database page under the Database Setup section
4) Check installation
Verify that SuperTokens has been installed correctly by running the following command:
supertokens --version
5) Other CLI commands
To view the list of available commands, for example to start, stop, list SuperTokens processes, run:
supertokens --help
Head over to the CLI docs to learn more about the available commands.
6) Integration with APIs and frontend
- 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.
7) Manage payments and license keys
- Go to the About License Keys section to learn about how you can manage license keys.
- Go to the About Payments section to learn about how payments will work.