Skip to content

Commit

Permalink
docs: updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
alejandromumo committed Jun 12, 2024
1 parent 1469c28 commit d5ccc64
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,5 +22,26 @@

InvenioRDM module for jobs management

Usage
=====

This module adds a custom scheduler to schedule jobs that exist in the local database.

To use this scheduler, the following command can be ran locally:

.. code-block:: console
$ celery -A invenio_app.celery beat -l ERROR --scheduler invenio_jobs.services.scheduler:RunScheduler -s /var/run/celery-schedule --pidfile /var/run/celerybeat.pid
Jobs can be managed through the administration view in the Invenio instance. By default, this view is disabled and can be enabled by adding the following configuration to the Invenio instance:

.. code-block:: python
JOBS_ADMINISTRATION_DISABLED = False
More Help
---------

Further documentation is available on
https://invenio-jobs.readthedocs.io/

0 comments on commit d5ccc64

Please sign in to comment.