Thanks to visit codestin.com
Credit goes to github.com

Skip to content

BUG: Documentation is missing adding schema folder to ingest-file #4224

@lu-kalk

Description

@lu-kalk

Describe the bug
The documentation on customizing the data model instructs you to add the schema folder to api and worker services in docker-compose.yml. But it also needs to be added to ingest-file and mounted when running aleph upgrade.

Expected behavior

### Mount a volume

If you deploy Aleph using Docker Compose, this is the most straight-forward approach.

<Steps>
  <Step>
    Add a separate item to the `volumes` configuration of the `api` and `worker` service in `docker-compose.yml` as shown below. This will make the contents of the `my-custom-schema` directory available inside of the Docker container at `/usr/local/my-custom-schema`.

    ```yaml title="docker-compose.yml"
    api:
      # ...
      volumes:
        # ...
        - ./my-custom-schema:/usr/local/my-custom-schema # Append this line

    worker:
      # ...
      volumes:
        # ...
        - ./my-custom-schema:/usr/local/my-custom-schema # Append this line

    ingest-file:
      # ...
      volumes:
        # ...
        - ./my-custom-schema:/usr/local/my-custom-schema # Append this line
    ```
  </Step>

  <Step>
    Set the `FTM_MODEL_PATH` configuration option to point to the directory that contains your custom model, for example `/usr/local/my-custom-schema`.
  </Step>

  <Step>
    Apply the changes:

    ```sh
    docker compose -d up
    ```
  </Step>

  <Step>
    When you upgrade aleph, make sure to mount the volume aswell:

    ```sh
    docker compose run --volume <path-to-schema>:/usr/local/my-custom-schema --rm shell aleph upgrade
    ```
  </Step>
</Steps>

Aleph version

Screenshots

Additional context
Add any other context about the problem here.

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugThings that should work, but don’ttriageThese issues need to be reviewed by the Aleph team

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions