Install Mathesar via Docker Compose¶
Requirements¶
-
You need Docker and Docker Compose.
We’ve tested with Docker v23 and Docker Compose v2.10. Older versions may not work.
-
You need root access.
-
If using a custom domain name
Have your domain name ready during the installation process and have your DNS pointing to your Mathesar server.
-
If connecting to an existing database
-
If installing on Windows, you need to have WSL installed first.
Install¶
-
Paste this command into your terminal to begin installing the latest version of Mathesar:
-
Follow the interactive prompts to configure your Mathesar installation.
-
When finished, the installer will display the URL where you can run Mathesar from your web browser.
Getting help
If you run into any problems during installation, see troubleshooting or open a ticket describing your problem.
Start/stop the server¶
The Mathesar server needs to be running for you to use Mathesar. If you restart your machine, you’ll need to start the server again.
-
Start Mathesar:
-
Stop Mathesar:
This stops all Mathesar Docker containers and releases their ports.
Note
If you customized the Mathesar configuration directory during installation, you’ll need to change /etc/mathesar
to your configuration directory.
Upgrade¶
Manually upgrade Mathesar to the newest version:
Upgrade from within Mathesar
You can also run the upgrade from within Mathesar by logging into as an admin user and navigating to “Administration” (in the top right menu) > “Software Update”
Uninstall¶
-
Remove all Mathesar Docker images and containers.
-
Remove configuration files.
Note
If you customized the Mathesar configuration directory during installation, you’ll need to change
/etc/mathesar
to your configuration directory. -
Remove Mathesar internal schemas.
If you connected Mathesar to an existing database, the installation process would have created a new schema for Mathesar’s use. You can remove this schema from that database as follows:
-
Connect to the database.
-
Delete the schema.
Danger
Deleting this schema will also delete any database objects that depend on it. This should not be an issue if you don’t have any data using Mathesar’s custom data types.
-