Search the OSCAR Documentation
1: OSCAR Install: Version 19 Installation
PrefaceThis basic install is adequate for a local install of OSCAR with scripted encrypted backups and Secure Socket Layer technology.
Document Version History
- v0.1 – Initial instructions for LTS Ubuntu 22.04 daily build – March 29, 2022
- v0.2 – Instructions for LTS Ubuntu 22.04 beta with some reformatting – April 1, 2022
- v0.3 – Instructions for LTS Ubuntu 22.04 release candidate – April 14, 2022
- v1.0 – Instructions for LTS Ubuntu 22.04 updated to reflect latest DEB and added Troubleshooting – April 29, 2022
- v1.1 – Promoted to default installation instructions – June 20, 2022
- You have at least two hours to spare. Downloading the Ubuntu ISO will take half an hour at 2 MB/s. Allow a minimum of 30 minutes to install Ubuntu, 15 minutes to install the infrastructure packages, 5 to download the OSCAR DEB and a final 18 minutes to install OSCAR itself. YMMV
- We recommend virtualization for enterprise level equipment. A virtualization environment (hypervisor) allows you to install one or more servers as virtual machines (VM) to improve security and ease maintenance. When provisioning the VM consider that the base install of Ubuntu and OSCAR will need about 15 GB and should have 3GB RAM allocated at a minimum for testing.
- You are using suitable hardware. While the OSCAR server may run on recent CPUs with 2GB RAM I consider 3GB a minimum. I suggest aiming to consumer grade machines with 8GB RAM for 1-3 MD’s increasing to server grade machines with 32GB for 7+ MD’s. Server grade machines offer component redundancy and improved reliability that is an advantage in any setting, but all systems need contingency plans for hardware failure. The author runs Intel Xeon server with 72GB RAM and hardware RAID as well as a i7 backup server with 16GB RAM for a database that is 8GB (compressed) in size and has 24 users
- You have installed the 22.04 64 bit LTS version of Ubuntu Jammy Jellyfish either natively or as a VM. The desktop version is slightly easier to debug for testing and the server version is “lighter” and more suitable for production. Both have been tested with OSCAR and are publicly supported by Ubuntu to April 2027 and with inexpensive subscription to 2032.
- For Production Use, if you are able to manually provide the password after a power outage or reboot, we strongly recommend configuring Ubuntu for *full disk encryption* which will mitigate the privacy breech that occurs with physical theft of the server.
- You have a basic level of Linux knowledge and you can open a Linux terminal
- You can cut and paste EXACTLY the following instructions (These instructions are sensitive to spelling packages and order. )
- There are significant disadvantages of trying ANY other version of the software versions specified herein unless you have extensive OSCAR configuration experience. Better to get it running on spec and only then try something a bit different.
TL; DRWell then lets give the skinny
Now skip to the configuration of MariaDB section for the tricky bits
sudo apt install default-jre tomcat9 unzip curl pgpgpg ufw wkhtmltopdf sudo apt install mariadb-server mariadb-client libmariadb-java
Installing The Infrastructure PackagesWE REITERATE Its a newbie error to deviate from these instructions in favour of something newer or “easier.” For production use we recommend these exact instructions as the community can support you if you are having problems. If you are both familiar with OSCAR and are testing or are willing to take chances when you colour outside the lines feel free to deviate from the instructions as you wish (review the version notes), and if its substantive deviation (and it works), please submit back your version.
Java 8, 11, 17In Ubuntu 22.04 you have the option of Java’s including 8, 11, 17 and 18. All but 18 are LTS releases and have been tested against OSCAR 19. Which of 8-17 to pick? Lets go with default
$ sudo apt install default-jre
Tomcat 9Java uses Apache Tomcat to present OSCAR’s webpages to your internet browser from the Universe repository.
This will trigger the installation of the following additional packages tomcat9-common libtcnative-1 libtomcat9-java Test by pointing your browser at http://localhost:8080 For a headless server you can test by installing a non graphical browser such as lynx. Otherwise test from another machine by replacing localhost with the IP of the server. If you don’t get a welcome screen then it is likely that Tomcat is not picking up your java, see troubleshooting in the Java section above.
sudo apt install tomcat9
Unzip CurlUnzip is used to decompress zip files. Curl is an internet file transfer utility. Pgpgpg is optionally used by OSCAR to encrypt charts for export. Uncomplicated Fire Wall (ufw) will secure the server. Unzip and UFW are probably already installed. Apt-get them to be sure
sudo apt install unzip curl pgpgpg ufw
Certbot (optional)Consider instructions from Ubuntu 20.04 if you control your website name
wkhtmltopdf 0.12.6OSCAR uses wkhtmltopdf to print some pdf content for eforms and faxing.
sudo apt install wkhtmltopdfIf after you finish installing OSCAR your eForms PDF fine then there is no need for further testing. Otherwise it is advised that you test with the parameters that you have in oscar,properties for the keyword WKHTMLTOPDF_ARGS Currently the DEB will configure something that could be tested with the following
$ wkhtmltopdf -s Letter -T 10mm -L 8mm -R 8mm --print-media-type --zoom 1.2 http://worldoscar.org test.pdf
MariaDB 10.6OSCAR uses this database to store your data. You can use the latest version of MariaDB obtained with:
OPTIONAL: If you want to install phpmyadmin (not described) as a MariaDB front end, do it now before the next step. This installation has no initial password and will need to be secured with the following Configuration section (follow the scripts suggested defaults EXCEPT for switching to unix socket authentication where you should answer n)
sudo apt install mariadb-server mariadb-client libmariadb-java
The plugin prevents non system root users from logging in to MariaDB, but allows for root users to log in to MariaDB directly without a password. By removing the plugin everyone (including OSCAR via the unprivileged tomcat user) can, and has to, sign into MariaDB by providing the MariaDB password.
Configuration MariaDBRun the mysql_secure_installation scipt. Do NOT switch to unix_socket authentication. The root password (for MariaDB) will not be set (it will be blank). Change it. Feel free to use numbers and letters in your password. If you proceed with the complication of using symbols “#,!, &,*, (, ), / , \ and $” in this password (e.g. pass&word), be sure to escape them when providing them to scripts below where the instructions supply ****** that require it (e.g. pass\&word).
Now there will only be the one root user set for MariaDB with the password you provided.
$ sudo mysql_secure_installation Switch to unix_socket authentication [Y/n] n Change the root password? [Y/n] New password: Re-enter new password: Remove anonymous users? [Y/n] Disallow root login remotely? [Y/n] Remove test database and access to it? [Y/n] Reload privilege tables now? [Y/n]
Installing OSCAR 19Download the OSCAR deb package from Sourceforge. There are several to choose from. You want the latest DEBs in the feed RSS Feeds
- Install the latest as package support for Ubuntu 22.04 is just being finalized.
- Note OSCAR is now running a rolling release and thus stability is not necessarily improved by a higher build number.
- Once installed if you are experiencing bugs wait for a new release and try either upgrading to a higher number build (the last 4 digits of the deb’s name) that incorporates the fix, or downgrading to an earlier deb that does not have the problem.
Now simply run the package and follow the instructions
wget http://sourceforge.net/projects/oscarmcmaster/files/Oscar\ Debian\+Ubuntu\ deb\ Package/oscar_emr19-66~1881.deb
The deb will provide feedback as to what it is doing however if you want more verbose details open another terminal window and invoke
sudo dpkg -i oscar_emr19-66~1881.deb
New installs get the following install screens. (for upgrades see Appendix 1 below) Start by providing the MySQL/MariaDB password you assigned. OSCAR will use it to set up a modernized version of the oscar_15 database for OSCAR 19. This window will give you the option to populate the database with a demo patient with which to develop familiarity with OSCAR. You can remove the demo data later with the following (replace ****** with your MariaDB/Mysql password, escaping any symbols (if any) that you used in the password).
sudo tail -f /usr/share/oscar-emr/Oscar19install.log
mysql -uroot -p******* oscar_15 < /usr/share/oscar-emr/undemo.sqlWhile customary production settings will be applied, they can be changed manually through editing /usr/share/tomcat9/oscar.properties in your favorite text editor. Note that OSCAR/Tomcat need to restart whenever the properties file is modified, to have the settings take effect. BE PATIENT The terminal will provide feedback as OSCAR is assembled and configured.
Allow for a good quarter hour for the deb to run. Once Tomcat restarts you will be given back the prompt. You can read the readme!
Selecting previously unselected package oscar-emr. (Reading database ... 163142 files and directories currently installed.) Preparing to unpack oscar_emr19-66~1881.deb ... Unpacking oscar-emr (19-66~1881) ... Setting up oscar-emr (19-66~1881) ... NOTE: Picked up JDK_JAVA_OPTIONS: --add-opens=java.base/java.lang=ALL-UNNAMED --add-opens=java.base/java.io=ALL-UNNAMED --add-opens=java.rmi/sun.rmi.transport=ALL-UNNAMED Edited tomcat9.service to allow Tomcat 9 read write on /usr/share/oscar-emr and /tmp Setting initial defaults for areacode in ON [x] Checking the MySQL password success [x] Determining locale success [x] Creating the new oscar_15 database success [x] Expanding War files success [x] Populating database with ON data success [x] Populating database with OLIS data success [x] Patching database to very latest schema success [x] Populating database with Demo data success [x] Configuring Tomcat success [x] Creating Drugref2 Property Files success [x] Updating drugref database success [x] Applying TallMAN rules to drugref success [x] Installing Ontario Specific eForms success [x] Installing HRM xml files success [x] Installing Ontario Rourke eForm under licence success [x] Restarting Tomcat success Successful installation of oscar deb revision 66~1881 Login at https://localhost:8443/oscar Your username is oscardoc Initial password mac2002 second level password (pin) 1117 Login at https://localhost:8443/oscar Your username is oscardoc Initial password mac2002 second level password (pin) 1117
Trying It OutAt this point you have a fairly plain install. To test the connection, click on the link displayed on the output above or open your web browser and type in the address manually. While most new proprietary browsers (Chrome, Safari, Edge etc) will work, for production use we strongly recommend FireFox ESR version, for stability, for tested OSCAR features and a large number of grease monkey addons that you can get on these pages. Did I mention Firefox is open source and doesn’t sell your data?
TroubleshootingWith luck everything will work as designed. However sometimes there are errors with simple solutions
- Tomcat won’t start. Check sudo service tomcat9 status . If an illegal property is passed in /etc/default/tomcat9 for JAVA_OPTS tomcat will not start
- You can login but you can’t upload Administration > forms/eforms > upload an image then the Tomcat 9 sandbox will need expansion. Edit tomcat9.service to list the allowed directories to include /tmp/ and /usr/share/oscar-emr/