Skip to content

Commit

Permalink
Merge pull request #4286 from mathesar-foundation/0.2.1
Browse files Browse the repository at this point in the history
Merging 0.2.1 into develop
  • Loading branch information
pavish authored Feb 25, 2025
2 parents 475407d + b376bd4 commit ffff687
Show file tree
Hide file tree
Showing 4 changed files with 62 additions and 56 deletions.
44 changes: 15 additions & 29 deletions docs/docs/administration/debug.md
Original file line number Diff line number Diff line change
@@ -1,42 +1,28 @@
# Debugging Mathesar

If your Mathesar installation isn't working as expected, you can use our `mathesar-debug` Docker image that adds more debugging output to the console and more verbose errors in the browser when something goes wrong. The additional information logged should help you or the Mathesar team diagnose the installation issue.
!!! warning "Not for production"
Debug mode should **not** be enabled in production environments, where it can cause performance issues and potentially expose sensitive information.

## Use the debugging Mathesar docker image
If your Mathesar installation isn't working as expected, you can prefix the docker command with `DEBUG=true` to add additional debugging output to the console and more verbose errors in the browser when something goes wrong. The additional information logged should help you or the Mathesar team diagnose any installation issues.

The debugging-enabled Mathesar docker image is available at the `mathesar/mathesar-debug` Docker repo. It's the same as the `mathesar/mathesar` image, other than adding more debugging output. To set it up:
### With Docker Compose

1. Run Mathesar with the `mathesar/mathesar-debug` image, and then
1. Observe and report any additional output or clues to the Mathesar team.

### Docker Compose

Just replace the line

```
image: mathesar/mathesar:latest
```

with
When debugging Mathesar's recommended [docker compose](../administration/install-via-docker-compose.md) installation method, add `DEBUG=true` to the beginning of the docker compose command:

```diff
- docker compose -f docker-compose.yml up
+ DEBUG=true docker compose -f docker-compose.yml up
```
image: mathesar/mathesar-debug:latest
```

### Basic Mathesar docker image

If you are just trying the Mathesar Docker image directly as instructed in the [introduction](../index.md#try-locally), replace the command

```
docker run -it --name mathesar -p 8000:8000 mathesar/mathesar:latest
```
### With the basic Mathesar docker image

with
If you are just trying the Mathesar Docker image directly as instructed in the [introduction](../index.md#try-locally), you will follow the same approach of setting `DEBUG=true`:

```
docker run -it --name mathesar -p 8000:8000 mathesar/mathesar-debug:latest
```diff
- docker run -it --name mathesar -p 8000:8000 mathesar/mathesar:latest
+ DEBUG=true docker run -it --name mathesar -p 8000:8000 mathesar/mathesar:latest
```

### Other setups
### Before version 0.2.1

The debugging docker image should work anywhere the production image works. This means you can just replace any pull or run of the image `mathesar/mathesar:latest` with `mathesar/mathesar-debug:latest`.
Previous versions of Mathesar used a dedicated debugging image called `mathesar/mathesar-debug`. These images will not be supported or created for Mathesar versions 0.2.1 or higher.
2 changes: 1 addition & 1 deletion docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ markdown_extensions:
permalink: true

extra:
mathesar_version: 0.2.0
mathesar_version: 0.2.1
version:
provider: mike
alias: true
2 changes: 1 addition & 1 deletion mathesar/__init__.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
default_app_config = 'mathesar.apps.MathesarConfig'

__version__ = "0.2.0"
__version__ = "0.2.1"
Loading

0 comments on commit ffff687

Please sign in to comment.