Skip to content

Commit fcb32da

Browse files
authored
Merge branch 'develop' into fix-documentation
2 parents 6a84b8b + ffff687 commit fcb32da

File tree

4 files changed

+62
-56
lines changed

4 files changed

+62
-56
lines changed

docs/docs/administration/debug.md

+15-29
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,28 @@
11
# Debugging Mathesar
22

3-
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.
3+
!!! warning "Not for production"
4+
Debug mode should **not** be enabled in production environments, where it can cause performance issues and potentially expose sensitive information.
45

5-
## Use the debugging Mathesar docker image
6+
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.
67

7-
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:
8+
### With Docker Compose
89

9-
1. Run Mathesar with the `mathesar/mathesar-debug` image, and then
10-
1. Observe and report any additional output or clues to the Mathesar team.
11-
12-
### Docker Compose
13-
14-
Just replace the line
15-
16-
```
17-
image: mathesar/mathesar:latest
18-
```
19-
20-
with
10+
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:
2111

12+
```diff
13+
- docker compose -f docker-compose.yml up
14+
+ DEBUG=true docker compose -f docker-compose.yml up
2215
```
23-
image: mathesar/mathesar-debug:latest
24-
```
25-
26-
### Basic Mathesar docker image
27-
28-
If you are just trying the Mathesar Docker image directly as instructed in the [introduction](../index.md#try-locally), replace the command
2916

30-
```
31-
docker run -it --name mathesar -p 8000:8000 mathesar/mathesar:latest
32-
```
17+
### With the basic Mathesar docker image
3318

34-
with
19+
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`:
3520

36-
```
37-
docker run -it --name mathesar -p 8000:8000 mathesar/mathesar-debug:latest
21+
```diff
22+
- docker run -it --name mathesar -p 8000:8000 mathesar/mathesar:latest
23+
+ DEBUG=true docker run -it --name mathesar -p 8000:8000 mathesar/mathesar:latest
3824
```
3925

40-
### Other setups
26+
### Before version 0.2.1
4127

42-
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`.
28+
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.

docs/mkdocs.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ markdown_extensions:
149149
permalink: true
150150

151151
extra:
152-
mathesar_version: 0.2.0
152+
mathesar_version: 0.2.1
153153
version:
154154
provider: mike
155155
alias: true

mathesar/__init__.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
default_app_config = 'mathesar.apps.MathesarConfig'
22

3-
__version__ = "0.2.0"
3+
__version__ = "0.2.1"

0 commit comments

Comments
 (0)