|
11 | 11 |
|
12 | 12 | > IMPORTANT |
13 | 13 | > |
14 | | -> Build and execution has been tested in Linux only. It should work in Mac OS, but likely not with Windows. Sorry. |
| 14 | +> Build and execution has been tested in Linux only. It should work in Mac OS and Windows with Windows Subsystem for Linux 2. |
15 | 15 |
|
16 | 16 | ## Getting Started |
17 | 17 |
|
18 | 18 | 1. Git clone this repository and set it as the working directory. |
19 | | -2. Download the installer files: |
| 19 | +1. Download the installer files: |
20 | 20 | * [Oracle Database 18c XE](https://oracle.com/xe) or any of the required installation files from [OTN](https://www.oracle.com/technetwork/database/) (supports versions up to 19.3 as of April 25, 2019) |
21 | 21 | * [Oracle Application Express](https://apex.oracle.com/download) (supports versions up 21.1 as of May 12, 2021) |
22 | | - * [Oracle REST Data Services](https://www.oracle.com/technetwork/developer-tools/rest-data-services/downloads/index.html) (supports versions up to 20.4.3 as of May 12, 2021) |
23 | | - * [Java Development Kit SE 8](https://www.oracle.com/technetwork/java/javase/downloads/) (**IMPORTANT**: Please download the tarball, e.g. `jdk-8u291-linux-x64.tar.gz`.) |
24 | | -3. Place all four files in the sub-directory `files`. |
25 | | -4. Create a new file that contains the required variables. Make a copy of `settings.env.sample`, e.g. `mysettings.env`, and modify as desired. The file should contain the following variables: |
26 | | - ```bash |
27 | | - ORACLE_SID=XE |
28 | | - ORACLE_PDB=XEPDB1 |
29 | | - ORACLE_PWD=Oracle18 |
30 | | - APEX_ADMIN_EMAIL=myemail@domain.com |
31 | | - APEX_ADMIN_PWD=Oracle__18 |
32 | | - APEX_PUBLIC_USER_PWD=Oracle18_1 |
33 | | - APEX_LISTENER_PWD=Oracle18_2 |
34 | | - APEX_REST_PUBLIC_USER_PWD=Oracle18_3 |
35 | | - ORDS_PUBLIC_USER_PWD=Oracle18_4 |
36 | | - INSTALL_FILE_APEX=apex_21.1.zip |
37 | | - INSTALL_FILE_ORDS=ords-20.4.3.050.1904.zip |
38 | | - INSTALL_FILE_JAVA=jdk-8u291-linux-x64.tar.gz |
39 | | - DOCKER_ORDS_PORT=50080 |
40 | | - DOCKER_EM_PORT=55500 |
41 | | - DOCKER_DB_PORT=51521 |
42 | | - DB_VERSION=18.4.0 |
43 | | - DB_EDITION=xe |
44 | | - DOCKER_NETWORK_NAME=das_network |
45 | | - ALLOW_DB_PATCHING=N |
46 | | - OML4R_SUPPORT=N |
47 | | - REST_ENABLED_SQL=Y |
48 | | - RTU_ENABLED=N |
49 | | - SQLDEVWEB=Y |
50 | | - DATABASEAPI=Y |
51 | | - ``` |
52 | | - |
53 | | - > * Specify the Docker network to attach to using the parameter `DOCKER_NETWORK_NAME`. The run script will check if the network exists, and if not, create it. |
54 | | - > * The parameter `RTU_ENABLED` has been introduced. It allows users to create containers that can be used to create an image from using Docker [commit](https://docs.docker.com/engine/reference/commandline/commit/). Set the value to "Y" if this ability is required. |
55 | | - > * Use the `FILES_DIR` parameter to specify the local path to all the required installation files, e.g. `/path/to/my/downloads`. |
56 | | - > * Set the value of `ALLOW_DB_PATCHING` to `Y` to preserve files needed to successfully patch the database software with *OPatch*. |
57 | | - > * [As of December 5, 2019](https://blogs.oracle.com/database/machine-learning%2c-spatial-and-graph-no-license-required-v2), Oracle Machine Learning (previously known as Oracle Advanced Analytics) option is now included with all editions of Oracle Database 12c R2 and later, including 18c Express Edition (XE). Use the `OML4R_SUPPORT` parameter to install database support for running embedded R scripts. At the moment, this option is only valid for 18c or later. |
58 | | - > * SQL Developer Web is now availablel with ORDS version 19.4. This feature is enabled by default. To turn it off, set the environment variable `SQLDEVWEB` to `N`. The REST-enabled SQL feature can be managed by the variable `REST_ENABLED_SQL`, but note that this value is ignored if SQL Developer Web is activated. For builds with earlier ORDS versions, the added configuration properties are safely ignored. |
59 | | - > * **New** `DATABASEAPI` parameter added to enable Database API support for ORDS 19.x and later. |
60 | | -5. Run the first script to grab the latest Docker [images](https://github.com/oracle/docker-images) from Oracle and build the Oracle Database image. The script takes one parameter, the environment filename (`mysettings.env`): |
| 22 | + * [Oracle REST Data Services](https://www.oracle.com/technetwork/developer-tools/rest-data-services/downloads/index.html) (supports versions up to 21.2.0.174.1826 as of July 10, 2021) |
| 23 | +1. For releases after [0.6.0](https://github.com/fuzziebrain/docker-apex-stack/releases/tag/0.6.0), either choose to use the binaries from [OpenJDK](openjdk.java.net/) or download a licensed Java runtime from Oracle. Please refer to the additonal notes section below for details about the `INSTALL_FILE_JAVA` parameter. |
| 24 | +1. Place all installer files in the sub-directory `files`. |
| 25 | +1. Create a file that contains the required environment variables for your build. Please refer to the additonal notes [below](#Additional-Notes-About-the-Settings-File) for more information about the various parameters that can be set. Included in this repository are two examples or templates that you can use: |
| 26 | + * [`settings.env.sample`](./settings.env.sample). |
| 27 | + * [`settings_db19c.env.sample`](./settings_db19c.env.sample). |
| 28 | +1. Run the first script to grab the latest Docker [images](https://github.com/oracle/docker-images) from Oracle and build the Oracle Database image. The script takes one parameter, the environment filename (`mysettings.env`): |
61 | 29 | ```bash |
62 | 30 | $ bash 01-build.sh mysettings.env |
63 | 31 | ``` |
64 | | -6. Run the final script to create and run the container, where the container name is `das`: |
| 32 | +1. Run the final script to create and run the container, where the container name is `das`: |
65 | 33 | ```bash |
66 | 34 | $ bash 02-run.sh das mysettings.env |
67 | 35 | ``` |
68 | 36 |
|
69 | | -Using the sample settings, the following are accessible: |
70 | | - |
71 | | -| Port | Application | URL | |
72 | | -|-|-|-| |
73 | | -| 50080 | APEX | http://localhost:50080 | |
74 | | -| 51521 | Database | N/A | |
75 | | -| 55500 | Enterprise Manager Express | https://localhost:55500/em | |
| 37 | +## Additional Notes About the Settings File |
| 38 | + |
| 39 | +* Specify the Docker network to attach to using the parameter `DOCKER_NETWORK_NAME`. The run script will check if the network exists, and if not, create it. |
| 40 | +* The parameter `RTU_ENABLED` has been introduced. **It is experimental and may not work**. It allows users to create containers that can be used to create an image from using Docker [commit](https://docs.docker.com/engine/reference/commandline/commit/). Set the value to "Y" if this ability is required. |
| 41 | +* Use the `FILES_DIR` parameter to specify the local path to all the required installation files, e.g. `/path/to/my/downloads`. |
| 42 | +* Set the value of `ALLOW_DB_PATCHING` to `Y` to preserve files needed to successfully patch the database software with *OPatch*. |
| 43 | +* [As of December 5, 2019](https://blogs.oracle.com/database/machine-learning%2c-spatial-and-graph-no-license-required-v2), Oracle Machine Learning (previously known as Oracle Advanced Analytics) option is now included with all editions of Oracle Database 12c R2 and later, including 18c Express Edition (XE). Use the `OML4R_SUPPORT` parameter to install database support for running embedded R scripts. At the moment, this option is only valid for 18c or later. |
| 44 | +* SQL Developer Web is now availablel with ORDS version 19.4. This feature is enabled by default. To turn it off, set the environment variable `SQLDEVWEB` to `N`. The REST-enabled SQL feature can be managed by the variable `REST_ENABLED_SQL`, but note that this value is ignored if SQL Developer Web is activated. For builds with earlier ORDS versions, the added configuration properties are safely ignored. |
| 45 | +* `DATABASEAPI` parameter added to enable Database API support for ORDS 19.x and later. |
| 46 | +* The variable `INSTALL_FILE_JAVA` accepts the following values: |
| 47 | + * `openjdk1.8` |
| 48 | + * `openjdk11` |
| 49 | + * The filename of Java runtime tarball that you can download from [here](https://www.oracle.com/technetwork/java/javase/downloads/). It is recommended that you download the latest Java 8 server JRE, e.g. `server-jre-8u291-linux-x64.tar.gz`. |
| 50 | +* Using the sample settings, the following are accessible: |
| 51 | + | Port | Application | URL | |
| 52 | + |-|-|-| |
| 53 | + | 50080 | APEX | http://localhost:50080 | |
| 54 | + | 51521 | Database | N/A | |
| 55 | + | 55500 | Enterprise Manager Express | https://localhost:55500/em | |
0 commit comments