> For the complete documentation index, see [llms.txt](https://docs.onelitefeather.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.onelitefeather.net/ingot/install-and-run/install-jar.md). # Run the JAR Run the Ingot server from its JAR file with Java 17 or newer, choose the working directory and data layout, and use the startup flags. This page runs Ingot directly on a JVM, without a container. You need Java 17 or newer. The build compiles Ingot for Java 17, the continuous integration builds it on Java 17 and 21, and the container images run Java 21. ## Before you begin * Java 17 or newer, on the path as `java`. Check with `java -version`. * The server JAR of the release, which the build names `ingot-.jar`. * A directory for the data, owned by the user that runs Ingot. ## Steps 1. Create the data directory and put the JAR in it: ```bash sudo mkdir -p /opt/ingot sudo cp ingot-.jar /opt/ingot/ cd /opt/ingot ``` 2. Start Ingot from that directory: ```bash java -jar ingot-.jar ``` Ingot uses the current directory as its working directory unless you pass `--working-directory` or `-wd`. Every file of the instance is created below it. 3. Read the first lines of the log. Ingot writes the configuration file, the database and the repositories on the first start, and it prints the address it listens on. 4. Check that the server answers. The health endpoint needs no login: ```bash curl -f http://localhost:8080/api/status/health ``` The answer is `200 OK`. ## Data layout Below the working directory Ingot creates: | Path | Content | | --------------------------- | --------------------------------------------------------------------------------------------------------------------------- | | `configuration.cdn` | The local configuration. Ingot writes it on every start, so edit it between runs. | | `reposilite.db` | The embedded SQLite database, with tokens, identity data and statistics. The name is the default of the `database` setting. | | `repositories/` | The artifacts of each repository, one directory per repository. | | `plugins/` | Plugin JARs that Ingot loads at start. | | `.local/reposilite.address` | The address of the running server. The container health check reads it. | | `logs/` | Rolling log files, `log_.txt`, with a `latest.log` link. | Logs go to `./logs` relative to the directory that the JVM starts in. Passing `--working-directory` does not move them. The log directory and the rolling policy are set in `tinylog.properties`, which is part of the JAR. {% hint style="info" %} The data directory of an existing Reposilite instance can be used by Ingot. For the steps and checks, follow [Upgrade from Reposilite 3.x](/ingot/operate-and-upgrade/upgrade-from-reposilite.md) and [Back up before upgrading](/ingot/operate-and-upgrade/back-up-before-upgrading.md) first. {% endhint %} ## Startup flags | Flag | Short | What it does | | ----------------------------------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `--working-directory ` | `-wd` | Directory for all instance files. Default: the current directory. | | `--local-configuration ` | `-lc` | Path of the local configuration file, relative to the working directory unless absolute. Default: `configuration.cdn`. | | `--local-configuration-mode ` | `-lcm` | `auto` writes the file on every start. `none` leaves the file alone. | | `--hostname
` | `-h` | Address to bind, overriding `hostname`. | | `--port ` | `-p` | Port to bind, overriding `port`. | | `--database ` | | Database, overriding `database`, for example `sqlite reposilite.db` or `mariadb localhost:3306 db user password`. | | `--disable-interactive-console` | `--disable-it` | Turns off the console on standard input. Use it when no terminal is attached. | | `--no-color` | | Disables ANSI colours in console output. | | `--run-migrations ` | | Runs the named opt-in data migrations. Repeat the parameter for more than one, for example `--run-migrations 001 --run-migrations 004`. Used only for the upgrade paths. | Pass JVM options before `-jar`, for example the heap size: ```bash java -Xmx512m -jar ingot-.jar --working-directory=/opt/ingot --disable-interactive-console ``` Every local setting can also come from an environment variable named `INGOT_LOCAL_` followed by the setting name in capitals, for example `INGOT_LOCAL_HOSTNAME`. The variable overrides the file and is not written back to it. The precedence is: defaults, then the file, then environment variables, then `-D` system properties, then the flags above. ## Result * The server listens on the address set by `hostname` and `port`, by default `0.0.0.0:8080`. * The working directory contains `configuration.cdn`, `reposilite.db`, `repositories/` and `logs/`. * `curl -f http://localhost:8080/api/status/health` returns `200 OK`. To stop Ingot in the foreground, type `stop` in the console, or send the process a termination signal. ## Related * [Run as a service](/ingot/install-and-run/run-as-service.md), to start Ingot at boot. * [Enable TLS](/ingot/install-and-run/enable-tls.md), to serve HTTPS from Ingot itself. * [Run behind a reverse proxy](/ingot/install-and-run/run-behind-reverse-proxy.md), to serve Ingot under a host name. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.onelitefeather.net/ingot/install-and-run/install-jar.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.