Skip to content

Commit e0fcd6e

Browse files
authored
Add Docker Hub link and clarify model volume mounting (#101)
- Add Docker Hub link to top-level README - Add "Mounting your models" section to examples/docker/README with volume mount examples - Clarify how to use -v flag for mapping model directories into container
1 parent d642cce commit e0fcd6e

2 files changed

Lines changed: 16 additions & 2 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ A universal metrics layer for consistent metrics across your data stack. Compati
55
- **Supported Formats:** Sidemantic (YAML, Python or SQL), Cube, dbt MetricFlow, LookML, Hex, Rill, Superset, Omni, BSL, GoodData LDM, Snowflake Cortex, Malloy, OSI, AtScale SML, ThoughtSpot TML
66
- **Databases:** DuckDB, MotherDuck, PostgreSQL, BigQuery, Snowflake, ClickHouse, Databricks, Spark SQL (also via ADBC)
77

8-
[Documentation](https://sidemantic.com) | [GitHub](https://github.com/sidequery/sidemantic) | [Discord](https://discord.com/invite/7MZ4UgSVvF) | [Demo](https://sidemantic.com/demo) (50+ MB data download, runs in your browser with Pyodide + DuckDB)
8+
[Documentation](https://sidemantic.com) | [GitHub](https://github.com/sidequery/sidemantic) | [Docker Hub](https://hub.docker.com/repository/docker/sidequery/sidemantic) | [Discord](https://discord.com/invite/7MZ4UgSVvF) | [Demo](https://sidemantic.com/demo) (50+ MB data download, runs in your browser with Pyodide + DuckDB)
99

1010
![Jupyter Widget Preview](preview.png)
1111

examples/docker/README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,20 @@
11
# Docker
22

3-
The published image is `sidequery/sidemantic` on Docker Hub. It includes all database drivers, the PostgreSQL wire-protocol server, and the MCP server.
3+
The published image is [`sidequery/sidemantic`](https://hub.docker.com/repository/docker/sidequery/sidemantic) on Docker Hub. It includes all database drivers, the PostgreSQL wire-protocol server, and the MCP server.
4+
5+
## Mounting your models
6+
7+
The container looks for model files (YAML, SQL, etc.) in `/app/models`. Use a volume mount (`-v`) to point it at your local models directory:
8+
9+
```bash
10+
# If your models are in ~/my-project/models/
11+
docker run -p 5433:5433 -v ~/my-project/models:/app/models sidequery/sidemantic
12+
13+
# Or from the current directory
14+
docker run -p 5433:5433 -v $(pwd)/models:/app/models sidequery/sidemantic
15+
```
16+
17+
The `-v local/path:/app/models` flag maps a folder on your machine into the container. Any `.yml`, `.sql`, or other semantic model files in that folder will be auto-detected and loaded.
418

519
## PostgreSQL server (default)
620

0 commit comments

Comments
 (0)