Skip to main content
Last updated:|... min read
Bug iconOpen OLake issuesBug iconOpen OLake doc issue

Docker Installation

Refer here to install OLake.

Refer here to build mongodb replicaset.

Docker Commands & Flags​

The two primary commands you’ll use are discover and sync, which both run inside the OLake Docker container. Below is a quick reference table:

CommandDescription
discoverScans the database (e.g., MongoDB) to generate catalog.json.
syncRuns initial snapshot and/or CDC-based replication.

Common Flags​

FlagExampleDescription
--config--config /mnt/config/config.jsonPath to the MongoDB (or other DB) connection config.
--catalog--catalog /mnt/config/catalog.jsonPath to the catalog file (list of tables/collections to replicate).
--destination--destination /mnt/config/writer.jsonPath to the writer configuration (local or S3).
--state--state /mnt/config/state.jsonPath to a file with saved offsets or resume tokens.

Remember: The -v (volume) flag is crucial for mounting your local olake_folder into /mnt/config within the container.


Need Assistance?

If you have any questions or uncertainties about setting up OLake, contributing to the project, or troubleshooting any issues, we’re here to help. You can:

  • Email Support: Reach out to our team at hello@olake.io for prompt assistance.
  • Join our Slack Community: where we discuss future roadmaps, discuss bugs, help folks to debug issues they are facing and more.
  • Schedule a Call: If you prefer a one-on-one conversation, schedule a call with our CTO and team.

Your success with OLake is our priority. Don’t hesitate to contact us if you need any help or further clarification!