Skip to content

Commit b1ca97e

Browse files
committed
Update README.md for Docker development setup
1 parent 9244573 commit b1ca97e

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,37 @@ Furthermore, for more detailed installation instructions, please refer to the [I
3131
- [Rpm installation](https://docs.ivorysql.org/en/ivorysql-doc/v5.0/v5.0/4.1#Rpm-installation)
3232
- [Source code installation](https://docs.ivorysql.org/en/ivorysql-doc/v5.0/v5.0/4.1#Source-code-installation)
3333

34+
## Development with Docker
35+
36+
For a consistent development environment, we provide a Docker-based setup that includes all build dependencies.
37+
38+
### Quick Start
39+
40+
```bash
41+
# Start the development containers
42+
docker compose up -d
43+
44+
# Enter the development container
45+
docker compose exec dev bash
46+
47+
# Configure and build IvorySQL
48+
./configure --prefix=/home/ivorysql/ivorysql \
49+
--enable-debug --enable-cassert \
50+
--with-uuid=e2fs --with-libxml
51+
52+
make -j$(nproc)
53+
make install
54+
55+
# Initialize database in Oracle mode
56+
initdb -D data_ora -m oracle
57+
58+
# Start the server
59+
pg_ctl -D data_ora start
60+
61+
# Run tests
62+
make oracle-check
63+
```
64+
3465
## Developer Formatting hooks and CI:
3566
- A pre-commit formatting hook is provided at `.githooks/pre-commit`. Enable it with `git config core.hooksPath .githooks`, or run `make code-format` (equivalently `bash tools/enable-git-hooks.sh`).
3667
- The hook depends only on in-tree tools `src/tools/pgindent` and `src/tools/pg_bsd_indent`. On commit it formats staged C/C++ files with pgindent and re-adds them to the staged area.

0 commit comments

Comments
 (0)