Skip to content

Commit

Permalink
Update documentation for dedicated exports location (#34)
Browse files Browse the repository at this point in the history
Adjustments for dedicated exports location.
Example of mapping exports outside the container
  • Loading branch information
Athemis authored Nov 4, 2024
1 parent b3abf05 commit a1668a4
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions doc/import-export.rst
Original file line number Diff line number Diff line change
Expand Up @@ -58,11 +58,11 @@ If you wish to import a rather large `.eln` archive (such as a full team export)
docker exec -it elabftw bin/console import:eln -h
As you can see, there are two mandatory arguments, the path to the file, and the Team ID where the import will be performed. The first thing to do is to copy the file in the right place in the container. It must be in `/elabftw/cache/elab` folder. Copy it with a command similar to this:
As you can see, there are two mandatory arguments, the path to the file, and the Team ID where the import will be performed. The first thing to do is to copy the file in the right place in the container. It must be in `/elabftw/exports` folder. Copy it with a command similar to this:

.. code-block:: bash
docker cp your.eln elabftw:/elabftw/cache/elab/
docker cp your.eln elabftw:/elabftw/exports/
Figure out the Team ID by looking at the Team from the Sysconfig panel, where the ID will be displayed next to the Team. Next, import your file with:

Expand Down Expand Up @@ -183,7 +183,19 @@ The Export tab from your Profile allows full export of all your data, in several

Very long exports will still be processed if you close your browser or navigate away.

Note to Sysadmins: on a given instance, export jobs are processed only one at a time. Users can each keep only 6 exported files. They are stored in `cache` and will disappear if the container is destroyed.
Note to Sysadmins: on a given instance, export jobs are processed only one at a time. Users can each keep only 6 exported files. They are stored in `exports` within the elabFTW root folder. The `exports` folder may be mapped to a path outside the container to prevent exceeding the disk usage quota of the container.
This can be done by adding a corresponding entry to `/etc/elabftw.yml` beneath the existing mapping for the upload path. In the example below, the exports folder is mapped to `/var/elabftw/exports`.

.. code:: yaml
volumes:
# this is where you will keep the uploaded files persistently
# for Windows users it might look like this
# - D:\Users\Nico\elab-data\web:/elabftw/uploads
# host:container
- /var/elabftw/web:/elabftw/uploads
# mapping of exports folder
- /var/elabftw/exports:/elabftw/exports
Exporting through CLI
---------------------
Expand Down

0 comments on commit a1668a4

Please sign in to comment.