Building from source

Building from source can allow you to customise SuperTokens as per your needs. This is recommended only for advanced users who are experts in authentication and security.

Please follow the CONTRIBUTING.md file for instructions on how to setup a development environment, make changes to the code and run tests.

Installing manually

1. Make sure you are in the supertokens-root folder, and have supertokens-core, supertokens-plugin-interface and a SuperTokens plugin repo in it.
2. Run ./startTestingEnv --wait
3. Open a new terminal in supertokens-root and run ls. Make sure you see install, core folder, plugin folder and the plugin-interface folder.
4. To install SuperTokens on your machine, run java -classpath "./cli/*" io.supertokens.cli.Main true $@ (you may need to use sudo, but first try without it)
5. You can kill the process started in step 2. This should also remove the files / folders mentioned in step 3.
6. Check that SuperTokens is installed by running supertokens
7. To uninstall SuperTokens, run supertokens uninstall

Creating a docker image

Due to the code architecture, one docker image only works with one database. For example, you can build a docker image that has SuperTokens and works with a MySQL database, or one that only works with MongoDB. In fact, we distribute a docker image for each supported database.

To build your own: 1)