Skip to main content

Get started with OSS

GitPod​

To start an online GitPod workspace for Logto, click here. Wait a few moment, you'll see the message like:

Gitpod is running

Logto uses port 3001 for its core service and port 3002 for the interactive Admin Console by default.

To continue your Logto journey, press Ctrl (or Cmd) and click the link that starts with https://3002-.... Enjoy!

Local​

The minimum recommended hardware requirements for hosting Logto are:

  • vCPU: 2
  • Memory: 8 GiB
  • Disk: 256 GiB

Docker Compose CLI usually comes with Docker Desktop.

caution

Do not use our docker compose command for production! Since we currently have a built-in Postgres database bundled together with the Logto app in docker-compose.yml, every time you re-execute the command a new database instance will be created, and any data persisted previously will be lost.

curl -fsSL https://raw.githubusercontent.com/logto-io/logto/HEAD/docker-compose.yml | docker compose -p logto -f - up

After a successful composition, you will see the message like:

Core app is running at http://localhost:3001
Core app is running at https://your-domain-url
Admin app is running at http://localhost:3002
Admin app is running at https://your-admin-domain-url

Heading to http://localhost:3002/ to continue your Logto journey. Enjoy!

Using an alternative URL for downloading

If you want to specify a URL for the Logto zip file, use the --download-url option. For example:

npm init @logto@latest -- --download-url=https://github.com/logto-io/logto/releases/download/v1.2.2/logto.tar.gz

Note the extra -- is needed for NPM to pass the arguments.

Configuration (optional)

Logto uses environment variables for configuration, along with .env file support. See Configuration for detailed usage and full variable list.

Check out Core service if you want more advanced controls or programmatic access to Logto.

Create an account​

Once you have successfully hosted Logto on your server, click on "Create account" on the welcome page. Keep in mind that the open-source version of Logto only allows for one account creation during the initial launch and does not support multiple accounts. The account creation process is limited to username and password combinations.

Dealing with local HTTPS development