$ ords -h
2025-07-08T21:09:46Z INFO ORDS has not detected the option '--config' and this will be set up to the default directory.
ORDS: Release 25.2 Production on Tue Jul 08 21:09:48 2025
Copyright (c) 2010, 2025, Oracle.
Configuration:
/etc/ords/config
Usage:
ords [OPTIONS] [COMMAND]
Oracle REST Data Services command line interface
Options:
--config <folder> Path to Oracle REST Data Services
configuration folder
--debug Equivalent to --verbose
-h, --help Show usage information for the command
--java-options <options...>
To specify additional Java options that should
be passed to the Java Virtual Machine
-v, --verbose Configure Oracle REST Data Services to run in
verbose mode
--version Show version information
Commands:
config Configure application and database connection
pool settings
extract Extracts Oracle REST Data Services scripts.
install Configure database connection and
install/upgrade Oracle REST Data Services
schema, ORDS database user and related
database objects.
migrate Migrates Oracle REST Data Services
configuration files and parameter file from
release 21.4.x and earlier releases.
pool Monitor pools of a running Oracle REST Data
Services instance
serve Launch Oracle REST Data Services in standalone
mode
uninstall Uninstall Oracle REST Data Services schema,
ORDS database user and related database
objects.
war Create a web application from the the
distributed ords.war that can be deployed in a
supported servlet container.
Run ords <COMMAND> --help for more information on a command.
For example run: ords config --help
$ ords config list
$ ords config set jdbc.InitialLimit 20
Setting
Value
Source
Description
database.api.enabled
true
Global
Specifies whether the Database API is enabled.
db.connectionType
basic
Pool
db.hostname
db-host-name
Pool
db.password
*****
Pool Wallet
db.port
1521
Pool
db.servicename
FREEPDB1
Pool
db.username
ORDS_PUBLIC_USER
Pool
feature.sdw
true
Pool
Specifies to enable the Database Actions feature.
jdbc.InitialLimit
20
Pool
Specifies the initial size for the number of connections that will be created.
jdbc.MaxLimit
50
Pool
Specifies the maximum number of connections.
jdbc.MinLimit
20
Pool
Specifies the minimum number of connections.
plsql.gateway.mode
proxied
Pool
Indicates if the PL/SQL Gateway functionality should be available for a pool or not.
restEnabledSql.active
true
Pool
security.requestValidationFunction
ords_util.authorize_plsql_gateway
Pool
Specifies a validation function to determine if the requested procedure in the URL should be allowed or disallowed for processing.
standalone.doc.root
/etc/ords/config/global/doc_root
Global
Points to the location where static resources to be served under the / root server path are located.
For developing APEX applications I use a virtual machine with Linux on it containing an Oracle APEX environment. This includes the following components:
Microsoft Hyper-V
Oracle Linux 8 including Gnome UI
Database FREE 23AI
ORDS 24.2
APEX 24.1
SQL Developer 23.1
Visual Studio Code (optional)
In this article I will explain how to install and configure the operating system on your server, which are the first two components (in bold).
Side note: These are alternative ways to use Oracle APEX:
Request a workspace on apex.oracle.com (free)
Run APEX on Oracle Cloud (free and paid options)
Download a VirtualBox Appliance (free)
Let us continue setting up our server.
Requirements
First things first; we need (virtual) hardware to run our server on. So let’s first look at some pc requirements for running a virtual server:
Windows Pro or Enterprise
Hyper-V enabled
50GB of available diskspace
8GB of memory (minimum)
This article can help you setup Hyper-V on your computer. Of course there are alternatives for virtualization software like VirtualBox and VMware if you can not use Hyper-V.
You can use an old computer instead of a virtual machine
Create virtual machine
Required downloads:
Oracle Linux R8 installation ISO from the yum repository. A boot ISO file is fine.
Follow these steps to create the virtual machine:
On your Windows computer, click Start and type “Hyper-V”.
Start Hyper-V Manager.
Click the Quick Create… button under Actions.
Do not select an operating system from the list. Use the Local installation source option instead.
Uncheck “This virtual machine will run Windows”.
Click Change installation source… and select the Oracle Linux R8 ISO file.
Click More options, give your Virtual Machine a name, like “APEX Development Server”.
The Network Default Switch setting is fine in most cases.
Click Create Virtual Machine.
After the virtual machine is created successfully, we change some settings:
Click Edit Settings.
On the left, click memory and change RAM to 8192 MB and uncheck Enable Dynamic Memory.
Optionally you can make the following changes:
Change the default number of virtual processors.
The name for the virtual machine can be changed (if you forgot at step 7).
I usually disable checkpoints until after installation of OS and software.
Click OK to save your settings.
Install Oracle Linux
Connect to the Virtual Machine and click Start.
Select “Install Oracle Linux 8.xx” with your arrow keys and type Enter.
Select a language to use during installation (default: English (United States)) and click Continue.
This is the installation summary page. Follow these steps:
First click Network & Host Name, change the hostname if you want (for example: apex.local), click apply and turn on the Ethernet (eth0) adapter. Click Done.
Then click Software Selection, select Workstation and click Done.
Then click Installation Destination, select Custom for Storage Configuration and click Done.
In the Manual Partitioning screen, click the “Click here to create them automatically” link.
Change the “/” partition (root) Desired Capacity from 70GB to 32GB.
Change the swap partition Desired Capacity to 8 GiB.
Change the “/home” partition mount point to “/opt/oracle” change Desired Capacity to 100 GiB and change Name from “home” to “opt_oracle” and Click Update Settings.
Click Done and then Accept Changes.
Set a password for root.
User Creation: Create the Oracle user.
Full name: Oracle
User name: oracle
Check: Make this user administrator
Give the user a password and click Done.
Click Begin Installation. This will take a while.
When the installation is done, click Reboot System.
Click License Information, I accept the License agreement, Done and Finish Configuration.
