</span></code></pre></div><p_=%endapi-method=endapi-method>{% endapi-method-response-example %} {% endapi-method-response %} {% endapi-method-spec %}</p><divclass="admonition info"><pclass=admonition-title>Info</p><p>Any repositories not synchronized with Docker Hub (e.g. staging or metadata repositories) will not be returned as part of the API. This also applies to images which the repository owner does not wish to be part of the primary image list.</p></div><h2id=running-fleet>Running Fleet<aclass=headerlinkhref=#running-fleettitle="Permanent link">¶</a></h2><divclass="admonition warning"><pclass=admonition-title>Warning</p><p>Fleet is a Java application and requires at least JRE 11.</p></div><p>Grab the latest Fleet release from <ahref=https://github.com/linuxserver/fleet/releases>GitHub</a>.</p><h3id=sql>SQL<aclass=headerlinkhref=#sqltitle="Permanent link">¶</a></h3><p>Fleet stores its data in a MariaDB database which you need to provide. In order for the application to manage its tables and procedures, the user you provide it needs to have the relevant <code>GRANT</code> permissions to the fleet database. The following script should be sufficient to get the initial database set up.</p><divclass="language-sql highlight"><pre><span></span><code><spanid=__span-1-1><aid=__codelineno-1-1name=__codelineno-1-1href=#__codelineno-1-1></a><spanclass=k>CREATE</span><spanclass=w></span><spanclass=k>SCHEMA</span><spanclass=w></span><spanclass=o>`</span><spanclass=n>fleet</span><spanclass=o>`</span><spanclass=p>;</span>
</span></code></pre></div><p>The username and password that you define must then be provided as part of Fleet's configuration.</p><h3id=configuration-file>Configuration File<aclass=headerlinkhref=#configuration-filetitle="Permanent link">¶</a></h3><p>All primary configuration for Fleet at runtime is loaded in via a <code>fleet.properties</code> file. This can be located anywhere on the file system, and is loaded in via a Runtime argument:</p><divclass="language-shell highlight"><pre><span></span><code><spanid=__span-2-1><aid=__codelineno-2-1name=__codelineno-2-1href=#__codelineno-2-1></a><spanclass=c1># Runtime</span>
</span></code></pre></div><p>All configuration can be loaded either via the config file, via JVM arguments, or via the system environment. Fleet will first look in the configuration file, then JVM runtime, and finally in the system environment. It will load the first value it finds, which can be useful when needing to override specific properties.</p><divclass="admonition info"><pclass=admonition-title>Info</p><p>If you place a property in the system environment, ensure that the property uses underscores rather than periods. This is due to a limitation in BASH environments where exported variables must not contain this character. E.g. <code>fleet.app.port=8080</code> becomes <code>export fleet_app_port=8080</code></p></div><table><thead><tr><thstyle="text-align: left;">Property Name</th><thstyle="text-align: left;">Purpose</th></tr></thead><tbody><tr><tdstyle="text-align: left;"><code>fleet.app.port</code></td><tdstyle="text-align: left;">The port which the application will be running under.</td></tr><tr><tdstyle="text-align: left;"><code>fleet.admin.secret</code></td><tdstyle="text-align: left;">A string used as part of the password key derivation process. This secret is prepended to the raw password before its key is derived, providing further pseudo-randomness to hashed passwords. <strong>Once set, this must not be changed!</strong> It is vital to remain the same, as it will be used during the password verification step. If Fleet is restarted with this removed or set differently, the password verification process will fail because previously hashed passwords will have been derived with the old secret.</td></tr><tr><tdstyle="text-align: left;"><code>fleet.database.driver</code></td><tdstyle="text-align: left;">The driver to use for connections to Fleet's database. This should be <code>org.mariadb.jdbc.Driver</code></td></tr><tr><tdstyle="text-align: left;"><code>fleet.database.url</code></td><tdstyle="text-align: left;">The full JDBC connection string to the database.</td></tr><tr><tdstyle="text-align: left;"><code>fleet.database.username</code></td><tdstyle="text-align: left;">The username of the SQL user which will be managing the data in the Fleet database. <strong>This should have full GRANT access</strong> to the fleet database as it also manages any database migrations.</td></tr><tr><tdstyle="text-align: left;"><code>fleet.database.password</code></td><tdstyle="text-align: left;">The password for the SQL user</td></tr></tbody></table><h3id=runtime-arguments>Runtime Arguments<aclass=headerlinkhref=#runtime-argumentstitle="Permanent link">¶</a></h3><p>As well as the base configuration file, Fleet also supports some runtime arguments by means of the <code>-D</code> flag. These can be used to direct Fleet to behave in a specific way at runtime.</p><divclass="admonition info"><pclass=admonition-title>Info</p><p>Unlike the properties defined above, these properties are only accessed via the JVM arguments (<code>-D</code>).</p></div><table><thead><tr><thstyle="text-align: left;">Runtime Argument</th><thstyle="text-align: left;">Purpose</th></tr></thead><tbody><tr><tdstyle="text-align: left;"><code>fleet.config.base</code></td><tdstyle="text-align: left;">The absolute path of the configuration file.</td></tr><tr><tdstyle="text-align: left;"><code>fleet.show.passwords</code></td><tdstyle="text-align: left;">Tells fleet to show passwords in plain text in its logs. <strong>Not recommended</strong>.</td></tr><tr><tdstyle="text-align: left;"><code>fleet.nuke.database</code></td><tdstyle="text-align: left;"><strong>Be very careful.</strong> This will tell Fleet to completely wipe and rebuild its database. This can be useful if the owner deems the database to be too far out of synchronisation with Docker Hub, or if images have since been removed but are still showing in Fleet.</td></tr><tr><tdstyle="text-align: left;"><code>fleet.skip.sync.on.startup</code></td><tdstyle="text-align: left;">By default, Fleet will run a synch
