Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.ditto.live/llms.txt

Use this file to discover all available pages before exploring further.

​
Prerequisites

Following are the minimum requirements that must be met before attempting to install Ditto.
  • Java Development Kit (JDK) version 17
  • One of the following platforms and architectures:
    • Windows x86_64
    • Linux x86_64
    • macOS arm64 (Apple Silicon)

​
Get Started

​
1. Clone the Repository

​
2. Configure Ditto

​
Get Ditto Database ID, Development Token, Auth URL, and Websocket URL

​
Add Ditto Credentials

  1. Copy the .env.sample file at the top level of the quickstart repo to .env and add your database ID and development token. 
    cp .env.sample .env
  2. Update the .env file with the Database ID and Development Token from your Ditto Database 
    DITTO_DATABASE_ID=YOUR_DB_ID
DITTO_DEVELOPMENT_TOKEN=YOUR_DEV_TOKEN
DITTO_AUTH_URL=https://YOUR_AUTH_URL
DITTO_WEBSOCKET_URL=wss://YOUR_AUTH_URL

​
3. Run the Application

  1. Open a terminal app and navigate to the quickstart/java-spring directory.
  2. Run the following command to launch the web app: 
    ./gradlew bootRun
  3. Open http://localhost:8080 in a browser to interact with the app.

​
4. Sync-Data Offline

​
Next Steps

All the Ditto Quickstart apps works together! Try running a quickstart app in other languages and see them all collaborate.

​
Additional Resources