Skip to content

Commit 54d0bff

Browse files
authored
fix: update docker compose for uta + update docs for manual dl (#78)
see uta issue: biocommons/uta#274 also fixes indentation for note about seqrepo_vol
1 parent 6f88644 commit 54d0bff

File tree

3 files changed

+28
-13
lines changed

3 files changed

+28
-13
lines changed

compose.anyvar.yaml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,20 @@ services:
2424
- seqrepo_vol:/usr/local/share/seqrepo
2525

2626
uta:
27+
# Test:
28+
# psql -XAt postgres://anonymous@localhost:5433/uta -c 'select count(*) from uta_20241220.transcript'
29+
# 329090
2730
image: biocommons/uta:uta_20241220
2831
environment:
2932
- POSTGRES_PASSWORD=some-password-that-you-make-up
3033
volumes:
3134
- uta_vol:/var/lib/postgresql/data
35+
- type: bind
36+
source: ./uta_20241220.pgd.gz
37+
target: /tmp/uta_20241220.pgd.gz
38+
read_only: true
39+
bind:
40+
create_host_path: false
3241
ports:
3342
- 127.0.0.1:5433:5432
3443

docs/source/configuration/docker_compose.rst

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -69,32 +69,36 @@ The following volumes may be required, depending on which services you run:
6969

7070
* ``seqrepo_vol``: Storage for sequence repository data. Required when running ``compose.anyvar.yaml`` or ``compose.test.yaml``.
7171

72-
.. note::
72+
.. note::
7373

74-
If you already have a SeqRepo database on your local filesystem, you can use it directly instead of the Docker volume. Both ``compose.anyvar.yaml`` and ``compose.test.yaml`` can be updated to bind-mount your local SeqRepo directory in place of ``seqrepo_vol``.
74+
If you already have a SeqRepo database on your local filesystem, you can use it directly instead of the Docker volume. Both ``compose.anyvar.yaml`` and ``compose.test.yaml`` can be updated to bind-mount your local SeqRepo directory in place of ``seqrepo_vol``.
7575

76-
For example, if your SeqRepo lives at ``/usr/local/share/seqrepo/2024-12-20``, replace:
76+
For example, if your SeqRepo lives at ``/usr/local/share/seqrepo/2024-12-20``, replace:
7777

78-
.. code-block:: yaml
78+
.. code-block:: yaml
7979
80-
volumes:
81-
- seqrepo_vol:/usr/local/share/seqrepo
80+
volumes:
81+
- seqrepo_vol:/usr/local/share/seqrepo
8282
83-
with:
83+
with:
8484

85-
.. code-block:: yaml
85+
.. code-block:: yaml
8686
87-
volumes:
88-
- $SEQREPO_ROOT_DIR:$SEQREPO_ROOT_DIR
87+
volumes:
88+
- $SEQREPO_ROOT_DIR:$SEQREPO_ROOT_DIR
8989
90-
Then export the path before starting the stack:
90+
Then export the path before starting the stack:
9191

92-
.. code-block:: bash
92+
.. code-block:: bash
9393
94-
export SEQREPO_ROOT_DIR=/usr/local/share/seqrepo/2024-12-20
94+
export SEQREPO_ROOT_DIR=/usr/local/share/seqrepo/2024-12-20
9595
9696
* ``uta_vol``: Storage for UTA database data. Required when running ``compose.anyvar.yaml``.
9797

98+
.. important::
99+
100+
You must download ``uta_20241220.pgd.gz`` from https://dl.biocommons.org/uta/ using a web browser and move it to the root of the repository.
101+
98102
* ``anyvar_vol``: Storage for AnyVar application data. Required when running ``compose.anyvar.yaml``.
99103

100104
Before starting a stack that relies on external volumes, ensure the required volumes exist. For example:

docs/source/getting_started/docker_compose.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ Create all required volumes:
2424
2525
% make volumes
2626
27+
Download ``uta_20241220.pgd.gz`` from https://dl.biocommons.org/uta/ using a web browser and move it to the root of the repository.
28+
2729
Then, launch the application:
2830

2931
.. code-block:: bash

0 commit comments

Comments
 (0)