-
-
Notifications
You must be signed in to change notification settings - Fork 323
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch '0.1.6' into release_notes_016
- Loading branch information
Showing
7 changed files
with
141 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
# Debug Mathesar | ||
|
||
For now, we only support turning on Debugging by using our special docker image. More methods will follow in future releases. | ||
|
||
## Use the debugging Mathesar docker image | ||
|
||
There is a debugging-enabled Mathesar docker image available at `mathesar/mathesar-debug` that is the same as the `mathesar/mathesar-prod` image, except that it has more debugging output available in the console where it's run, and it also produces more verbose errors in the browser when something goes wrong. | ||
|
||
You can use this image to figure out (or to help the Mathesar team figure out) what's wrong if your Mathesar installation isn't working as expected. The procedure is to | ||
|
||
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-prod:latest | ||
``` | ||
|
||
with | ||
|
||
``` | ||
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-prod:latest | ||
``` | ||
|
||
with | ||
|
||
``` | ||
docker run -it --name mathesar -p 8000:8000 mathesar/mathesar-debug:latest | ||
``` | ||
|
||
### Other setups | ||
|
||
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-prod:latest` with `mathesar/mathesar-debug:latest`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,86 @@ | ||
# Upgrade Mathesar to 0.1.6 | ||
|
||
### For installations using Docker Compose | ||
|
||
If you have a Docker compose installation (including one from the guided script), run the command below: | ||
|
||
``` | ||
docker compose -f /etc/mathesar/docker-compose.yml up --pull always -d | ||
``` | ||
|
||
!!! warning "Your installation directory may be different" | ||
You may need to change `/etc/mathesar/` in the command above if you chose to install Mathesar to a different directory. | ||
|
||
|
||
### For installations done from scratch | ||
|
||
If you installed Mathesar [from scratch](../../installation/build-from-source/index.md), then use these steps to upgrade your installation to 0.1.6. | ||
|
||
1. Go to your Mathesar installation directory | ||
|
||
``` | ||
cd xMATHESAR_INSTALLATION_DIRx | ||
``` | ||
|
||
!!! note | ||
Your installation directory may be different from above if you used a different directory when installing Mathesar. | ||
|
||
1. Pull version 0.1.6 from the repository | ||
|
||
``` | ||
git pull https://github.com/mathesar-foundation/mathesar.git | ||
git checkout 0.1.6 | ||
``` | ||
|
||
1. Update Python dependencies | ||
|
||
``` | ||
pip install -r requirements-prod.txt | ||
``` | ||
|
||
1. Activate our virtual environment | ||
|
||
``` | ||
source ./mathesar-venv/bin/activate | ||
``` | ||
|
||
1. You can skip the following if you're upgrading from versions 0.1.4 and above. | ||
- If you're upgrading from versions <= 0.1.3, update your environment variables according to the [the new configuration specification](../../configuration/env-variables.md#db). | ||
- In particular, you must put the connection info for the internal DB into new `POSTGRES_*` variables. The `DJANGO_DATABASE_URL` variable is no longer supported. | ||
|
||
1. Add the environment variables to the shell before running Django commands | ||
|
||
``` | ||
export $(sudo cat .env) | ||
``` | ||
|
||
1. Run Django migrations | ||
|
||
``` | ||
python manage.py migrate | ||
``` | ||
|
||
1. Download and extract frontend assets | ||
|
||
``` | ||
wget https://github.com/mathesar-foundation/mathesar/releases/download/0.1.6/static_files.zip | ||
unzip static_files.zip && mv static_files mathesar/static/mathesar && rm static_files.zip | ||
``` | ||
|
||
1. Compile Mathesar translation files | ||
|
||
``` | ||
python manage.py compilemessages | ||
``` | ||
|
||
1. Update Mathesar functions on the database: | ||
|
||
``` | ||
python -m mathesar.install --skip-confirm | tee /tmp/install.py.log | ||
``` | ||
|
||
1. Restart the gunicorn server | ||
|
||
``` | ||
systemctl restart gunicorn | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters