Skip to content

Commit ee0f742

Browse files
committed
Updated debug docs for Mathesar
1 parent d7dde42 commit ee0f742

File tree

1 file changed

+13
-30
lines changed

1 file changed

+13
-30
lines changed

docs/docs/administration/debug.md

+13-30
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,25 @@
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+
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.
44

5-
## Use the debugging Mathesar docker image
5+
### With Docker Compose
66

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:
7+
When debugging Mathesar's reccommended [docker compose](../administration/install-via-docker-compose.md) installation method, add `DEBUG=true` to the beginning of the docker compose command:
88

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
9+
```diff
10+
- docker compose -f docker-compose.yml up
11+
+ DEBUG=true docker compose -f docker-compose.yml up
1812
```
1913

20-
with
21-
22-
```
23-
image: mathesar/mathesar-debug:latest
24-
```
14+
### With the basic Mathesar docker image
2515

26-
### Basic Mathesar docker image
16+
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`:
2717

28-
If you are just trying the Mathesar Docker image directly as instructed in the [introduction](../index.md#try-locally), replace the command
29-
30-
```
31-
docker run -it --name mathesar -p 8000:8000 mathesar/mathesar:latest
32-
```
33-
34-
with
35-
36-
```
37-
docker run -it --name mathesar -p 8000:8000 mathesar/mathesar-debug:latest
18+
```diff
19+
- docker run -it --name mathesar -p 8000:8000 mathesar/mathesar:latest
20+
+ DEBUG=true docker run -it --name mathesar -p 8000:8000 mathesar/mathesar:latest
3821
```
3922

40-
### Other setups
23+
### Before version 0.2.1
4124

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`.
25+
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.

0 commit comments

Comments
 (0)