summaryrefslogtreecommitdiff
path: root/site/docs/getting-started/0-installation.md
diff options
context:
space:
mode:
authorDante Niewenhuis <d.niewenhuis@hotmail.com>2024-11-05 14:17:08 +0100
committerGitHub <noreply@github.com>2024-11-05 14:17:08 +0100
commit0f835d57b0e989e25aa0b71fe374a0fb1a94e86f (patch)
tree8d777634dbb8a3e03b14ecc4208228f92127f4b5 /site/docs/getting-started/0-installation.md
parentf3e578a2a43c99997dbf35e09debfde255a4ae22 (diff)
Documentation update (#261)
* Updated a lot of documentation, added a new get-started tutorial. * Applied Spotless * Applied Spotless Java * Added bitbrains workload to site
Diffstat (limited to 'site/docs/getting-started/0-installation.md')
-rw-r--r--site/docs/getting-started/0-installation.md40
1 files changed, 8 insertions, 32 deletions
diff --git a/site/docs/getting-started/0-installation.md b/site/docs/getting-started/0-installation.md
index e9f539a8..281e811f 100644
--- a/site/docs/getting-started/0-installation.md
+++ b/site/docs/getting-started/0-installation.md
@@ -6,7 +6,7 @@ description: How to install OpenDC locally, and start experimenting in no time.
This page describes how to set up and configure a local single-user OpenDC installation so that you can quickly get your
experiments running. You can also use the [hosted version of OpenDC](https://app.opendc.org) to get started even
-quicker.
+quicker (The web server is however missing some more complex features).
## Prerequisites
@@ -14,42 +14,18 @@ quicker.
1. **Supported Platforms**
OpenDC is actively tested on Windows, macOS and GNU/Linux.
2. **Required Software**
- A Java installation of version 17 or higher is required for OpenDC. You may download the
+ A Java installation of version 19 or higher is required for OpenDC. You may download the
[Java distribution from Oracle](https://www.oracle.com/java/technologies/downloads/) or use the distribution provided
by your package manager.
## Download
-To get an OpenDC distribution, download a recent version from our [Releases](https://github.com/atlarge-research/opendc/releases)
-page on GitHub.
+To get an OpenDC distribution, download a recent version from our [Releases](https://github.com/atlarge-research/opendc/releases) page on GitHub.
+For basic usage, the OpenDCExperimentRunner is all that is needed.
## Setup
-Unpack the downloaded OpenDC distribution and try the following command:
-
-```bash
-$ bin/opendc-server
-__ ____ __ _____ ___ __ ____ ______
- --/ __ \/ / / / _ | / _ \/ //_/ / / / __/
- -/ /_/ / /_/ / __ |/ , _/ ,< / /_/ /\ \
---\___\_\____/_/ |_/_/|_/_/|_|\____/___/
-2022-09-12 10:30:22,064 INFO [org.fly.cor.int.dat.bas.BaseDatabaseType] (main) Database: jdbc:h2:file:./data/opendc.db (H2 2.1)
-2022-09-12 10:30:22,089 WARN [org.fly.cor.int.dat.bas.Database] (main) Flyway upgrade recommended: H2 2.1.214 is newer than this version of Flyway and support has not been tested. The latest supported version of H2 is 2.1.210.
-2022-09-12 10:30:22,098 INFO [org.fly.cor.int.com.DbMigrate] (main) Current version of schema "PUBLIC": 1.0.0
-2022-09-12 10:30:22,099 INFO [org.fly.cor.int.com.DbMigrate] (main) Schema "PUBLIC" is up to date. No migration necessary.
-2022-09-12 10:30:22,282 INFO [org.ope.web.run.run.OpenDCRunnerRecorder] (main) Starting OpenDC Runner in background (polling every PT30S)
-2022-09-12 10:30:22,347 INFO [io.quarkus] (main) opendc-web-server 2.1-rc1 on JVM (powered by Quarkus 2.11.1.Final) started in 1.366s. Listening on: http://0.0.0.0:8080
-2022-09-12 10:30:22,348 INFO [io.quarkus] (main) Profile prod activated.
-2022-09-12 10:30:22,348 INFO [io.quarkus] (main) Installed features: [agroal, cdi, flyway, hibernate-orm, hibernate-validator, jdbc-h2, jdbc-postgresql, kotlin, narayana-jta, opendc-runner, opendc-ui, resteasy, resteasy-jackson, security, smallrye-simHyperVisorContext-propagation, smallrye-openapi, swagger-ui, vertx]
-```
-This will launch the built-in single-user OpenDC server on port 8080. Visit
-[http://localhost:8080](http://localhost:8080) to access the bundled web UI.
-
-## Configuration
-
-OpenDC can be configured using the configuration files located in the `conf` directory. By default, all user data is
-stored in the `data` directory using the H2 database engine.
-
-## Multi-tenant deployment
-
-For more information on setting up multi-tenant, non-trivial deployments, see the [Deployment Guide](docs/advanced-guides/deploy.md).
+Unpack the downloaded OpenDC distribution. Opening OpenDCExperimentRunner results in two folders, `bin` and `lib`.
+`lib` contains all `.jar` files needed to run OpenDC. `bin` two executable versions of the OpenDCExperimentRunner.
+In the following pages, we discuss how to run an experiment using the executables.
+