Skip to content

Commit

Permalink
docs: adds rclone section, removes note to configure rclone file
Browse files Browse the repository at this point in the history
  • Loading branch information
niquerio committed Jan 30, 2025
1 parent 9edcb7f commit a1bc4d5
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ AIM's python code repository

This will:
* set up the initial environment variables file
* set up the rclone config with the example file
* build the docker image
* install the python dependencies
* Set up the database for digifeeds
Expand All @@ -28,11 +27,9 @@ AIM's python code repository

3. Edit `.env` with actual environment variables

4. Edit `.config/rclone/rclone.conf` with your actual values
4. If using VSCode for editing, the repository is set up for use with dev containers. You will have to rebuild the container in there.

5. If using VSCode for editing, the repository is set up for use with dev containers. You will have to rebuild the container in there.

6. In the app container, use `poetry shell` to enable the virtual environment. Otherwise use:
5. In the app container, use `poetry shell` to enable the virtual environment. Otherwise use:

```bash
docker compose run --rm app poetry run YOUR_COMMAND
Expand Down Expand Up @@ -120,6 +117,14 @@ docker compose run --rm app poetry run aim digifeeds --help
This will show the commands available for the digifeeds cli applciation.
### Rclone
This applicaiton uses [Rclone](https://rclone.org/) to work with remote storage. It uses the [rclone-python](https://pypi.org/project/rclone-python/) for working with rclone in python.
To configure new remotes for use with the application use environment variables. The names of the environment variables are on the documentation page for a given remote. We use environment variables because it so all of the configuration happens in `.env` instead of in multiple places.
If you want to quickly add a remote to try something out, you can use `rclone configure` in the container terminal. The config file is ignored.
## Tests
To run tests:
Expand Down

0 comments on commit a1bc4d5

Please sign in to comment.