{"id":24313816,"url":"https://github.com/martindsouza/docker-oracle-ords","last_synced_at":"2025-09-26T19:31:27.789Z","repository":{"id":92678984,"uuid":"107070767","full_name":"martindsouza/docker-oracle-ords","owner":"martindsouza","description":"ORDS Docker Image","archived":false,"fork":false,"pushed_at":"2020-09-27T21:27:43.000Z","size":23,"stargazers_count":32,"open_issues_count":10,"forks_count":25,"subscribers_count":7,"default_branch":"master","last_synced_at":"2024-05-01T15:49:06.369Z","etag":null,"topics":["docker-image","oracle","oracle-ords"],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/martindsouza.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null},"funding":{"github":"martindsouza"}},"created_at":"2017-10-16T02:52:20.000Z","updated_at":"2023-06-22T20:19:10.000Z","dependencies_parsed_at":"2023-03-13T17:27:09.420Z","dependency_job_id":null,"html_url":"https://github.com/martindsouza/docker-oracle-ords","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/martindsouza%2Fdocker-oracle-ords","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/martindsouza%2Fdocker-oracle-ords/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/martindsouza%2Fdocker-oracle-ords/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/martindsouza%2Fdocker-oracle-ords/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/martindsouza","download_url":"https://codeload.github.com/martindsouza/docker-oracle-ords/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234338048,"owners_count":18816450,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker-image","oracle","oracle-ords"],"created_at":"2025-01-17T09:13:40.262Z","updated_at":"2025-09-26T19:31:27.452Z","avatar_url":"https://github.com/martindsouza.png","language":"Shell","funding_links":["https://github.com/sponsors/martindsouza"],"categories":[],"sub_categories":[],"readme":"# Oracle ORDS Dockerfile\n\n- [Pre-Install](#pre-install)\n- [Build ORDS Docker Image](#build-ords-docker-image)\n- [Run Container](#run-container)\n  - [Generate Configuration](#generate-configuration)\n  - [Configuration Exists](#configuration-exists)\n  - [Health Check](#health-check)\n  - [Logs](#logs)\n- [Container Parameters](#container-parameters)\n- [Development](#development)\n\nThis docker container will run Oracle ORDS in standalone mode.\n\n_The reason why this image is not posted on [Docker Hub](https://hub.docker.com) is due to Oracle requiring that you download and accept their terms and conditions for ORDS._\n\n\n## Pre-Install\n\n\nDownload [ORDS](http://www.oracle.com/technetwork/developer-tools/rest-data-services/downloads/index.html). I'll assume that this is stored in your `~/Downloads` directory. The downloaded file will look like `~/Downloads/ords.18.1.1.95.1251.zip`\n\n```bash\n# Clone this repo\ngit clone https://github.com/martindsouza/docker-oracle-ords.git\ncd docker-oracle-ords\n\n# Copy the ords*.zip file to files/ folder\n# Make sure only one ords file is in files directory\ncp ~/Downloads/ords-*.zip files/\n\n```\n\n## Build ORDS Docker Image\n\nNote: tagging with ORDS version number allows you to have multiple ORDS images for each ORDS release.\n\n```bash\nORDS_VERSION=19.4.0\ndocker build \\\n  -t oracle-ords:$ORDS_VERSION \\\n  -t oracle-ords:latest \\\n  .\n```\n\n## Run Container\n\nThis image allows you to run the ORDS container to either generate the ORDS configuration or use an existing one. Full explanations of all the supported [parameters](#parameters) is below.\n\n### Generate Configuration\n\nRunning the ORDS container this way will setup the ORDS configuration in the mapped volume drive (`/opt/ords`) and only needs to be run once. The following commands demonstrate how to do this. It also has an optional `--rm` parameter that will remove the container after first use. This is used since we can use a \"simpler\" `run` command once the ORDS configuration exists. It also prevents the `-e` variables which contain the passwords to be attached to a container. \n\n```bash\n#Note: DB_PORT is NOT the port that you mapped to your Oracle DB Docker image. It's the port that the database natively has open.\n# It's recommended to leave it as 1521\n# Optional: If DB is in another Docker machine include: --network=\u003cdocker_network_name\u003e \\\n# ~/docker/ords/ords-18.1.1/config is the directory where the ORDS configuration will be saved. If it doesn't exist Docker will create it.\n# \n# ORACLE XE Changes:\n#\n# DB_HOSTNAME=oracle-xe \\\n# DB_SERVICENAME=xepdb1 \\\n#\nORDS_CONF_DIR=~/docker/ords/19.4.0\nORDS_APEX_IMG_DIR=~/docker/files/apex/19.2.0/images\n\ndocker run -it --rm \\\n  --network=oracle_network \\\n  -e TZ=America/Edmonton \\\n  -e DB_HOSTNAME=oracle-xe \\\n  -e DB_PORT=1521 \\\n  -e DB_SERVICENAME=XEPDB1 \\\n  -e APEX_PUBLIC_USER_PASS=oracle \\\n  -e APEX_LISTENER_PASS=oracle \\\n  -e APEX_REST_PASS=oracle \\\n  -e ORDS_PASS=oracle \\\n  -e SYS_PASS=Oracle18 \\\n  --volume $ORDS_CONF_DIR/config:/opt/ords \\\n  --volume $ORDS_APEX_IMG_DIR:/ords/apex-images \\\n  -p 32513:8080 \\\n  oracle-ords:latest\n```\n\nOn your laptop go to [localhost:32513/ords](http://localhost:32513/ords). For SQL Developer Web go to: http://localhost:32513/ords/sql-developer\n\n### Configuration Exists\n\nIn this case ORDS will assume that your configuration exists (found in the mapped `/opt/ords` folder). A few differences to note from previous `run` command:\n\n- Includes a `name` attribute. This will allows to reference the container by name when using `docker start ords` and `docker stop ords`.\n- Does not include all database login information (since exists in configuration file)\n- Does not self-remove\n- `-d` (detached mode - optional) is used so that it does not lock the current terminal screen\n\n```bash\ndocker run -it -d \\\n  --name=ords \\\n  --network=oracle_network \\\n  -e TZ=America/Edmonton \\\n  --volume ~/docker/ords/19.4.0/config:/opt/ords \\\n  --volume ~/docker/files/apex/19.2.0/images:/ords/apex-images \\\n  -p 32513:8080 \\\n  oracle-ords:latest\n```\n\n### Health Check\n\nThis container includes a healthcheck to ensure that ORDS is working properly:\n\n```bash\ndocker ps\n\n# Should result in something like the following\n# Note the (healthy) status\nCONTAINER ID  IMAGE        COMMAND                 CREATED       STATUS                  PORTS                    NAMES\nb7694a2d62ba  ords:18.1.1  \"/ords/config-run-or…\"  15 hours ago  Up 15 hours (healthy)   0.0.0.0:32513-\u003e8080/tcp  ords\n```\n\n### Logs\n\nIf you want to see the logs from ORDS that would normally output on the screen you can run:\n\n```bash\ndocker logs ords\n```\n\nWhere `ords` is the name of your container.\n\n## Container Parameters\nParameter | Description\n--- | ---\n`--name` | Optional: Name to label container\n`--network` | Optional: If your database is part of a Docker network, attach this container to same network.\n`-e TZ` | Optional: Timezone for ORDS\n`-e DB_HOSTNAME` | Hostname of Oracle DB\n`-e DB_PORT` | TNS port to DB. Note: If on a Docker Network don't use the mapped port. Most likely this will always be `1521`\n`-e DB_SERVICENAME` | DB servicename\n`-e APEX_PUBLIC_USER_PASS` | `APEX_PUBLIC_USER` password (to be created)\n`-e APEX_LISTENER_PASS` | `APEX_LISTENER` password (to be created)\n`-e APEX_REST_PASS` | `APEX_REST` password (to be created)\n`-e ORDS_PASS` | `ORDS_PUBLIC_USER` password (to be created)\n`-e SYS_PASS` | `SYS` password\n`-e REST_SQL` | REST enabled SQL. Default: `true`\n`-e FEATURE_SDW` | SQL Developer Web. Default: `true`. *Note: `REST_SQL` must be `true` as well*\n`--volume \u003clocal dir\u003e:/ords/apex-images` | Directory that contains images for APEX\n`--volume \u003clocal dir\u003e:/opt/ords`  | Optional: Directory to/that contains ORDS config. If this is not provided, the configuration will be saved in the container and will **not** be available if the container is deleted. If `defaults.xml` is not found in the folder ORDS will try to install.\n`-p 1234:8080`  |  Port mapping, `8080` is the port in the container and can not be modified.\n\n\n## Development\n\nPlease read the [development](docs/development.md) documentation for more info on how to help develop this Docker image.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmartindsouza%2Fdocker-oracle-ords","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmartindsouza%2Fdocker-oracle-ords","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmartindsouza%2Fdocker-oracle-ords/lists"}