Skip to content

Management Commands

Andy Byers edited this page Jun 11, 2018 · 8 revisions

Janeway has numerous Custom Management Commands, here we will list them and give information about how to use them and what they do.

[consortial_billing]

fetch_fixer_ex_rates

[cron]

execute_cron_tasks
send_digest_emails
send_reminders

[metrics]

accesses_to_historic
process_crossref_events
reload_access_dump

[utils]

alter_domains
backup
build_assets
check_mailgun_stat
check_settings_files
clean_duplicate_settings
doi_check
generate_a_records
import_content
import_issue_images
import_jms_articles
import_jms_user
import_jms_users
import_journal_metadata
install_cron
install_janeway
install_journal
install_plugins
list_backend_articles
list_backend_users
migrate_plugins
move_press
nuke_db
nuke_import_cache
redirects
register_all_crossref
register_crossref_doi
reset_frozen_authors
restore_defaults_to_journals
run_upgrade
scrape_oai
scrape_ojs_page
scrape_up_page
show_configured_journals
show_id
similarity_check_csv
sort_journals_by_name
store_ithenticate_scores
sync_journals_to_sites
sync_settings_to_journals
up_fix_article_images
up_fix_name_imports
up_import_editing_article
up_import_review_article
update_defaults
update_defaults_json
update_emails
update_render_galleys

alter_domains

  • Location: /src/utils/management/commands/
  • Usage: python3 manage.py alter_domains journal_code (optional)
  • Purpose: This management command allows you to change the domains of any journal or the press and syncs this with the sites app.

backup

  • Location: /src/utils/management/commands/
  • Usage: python3 manage.py backup
  • Purpose: Provides a full dump of the database and file structure in a zip file, inside src/temp/

build_assets

  • Location: /src/utils/management/commands/
  • Usage: python3 manage.py build_assets
  • Purpose: Executes build_assets modules for each of the themes installed

check_mailgun_stat

  • Location: /src/utils/management/commands/
  • Usage: python3 manage.py check_mailgun_stat
  • Purpose: Can be enabled/disabled in settings, if enabled contacts the Mailgin API to check delivery status of emails

check_settings_files

  • Location: /src/utils/management/commands/
  • Usage: python3 manage.py check_mailgun_stat
  • Purpose:

doi_check

  • Location: /src/utils/management/commands/
  • Usage: python3 manage.py doi_check journal_code (optional)
  • Purpose: Checks all minted DOIs to ensure they are resolving correctly, results of the command can be checked in the /reports/ app.

generate_a_records

  • Location: /src/utils/management/commands/
  • Usage: python3 manage.py generate_a_records server_ip_address (required)
  • Purpose: Outputs text A records for you to install in your DNS server

install_cron

  • Location: /src/utils/management/commands/
  • Usage: python3 manage.py install_cron --action (options: test or quiet)
  • Purpose: Installs cron tasks for Janeway

install_janeway

  • Location: /src/utils/management/commands/
  • Usage: python3 manage.py install_janeway
  • Purpose: Completes setup routines for Janeway

install_journal

  • Location: /src/utils/management/commands/
  • Usage: python3 manage.py install_journal --journal_name name --journal_code code --base_url www.example.org --delete
  • Purpose: Will setup a new journal using the given options, delete is set to True if present, otherwise it should be left it, if it is present a journal with the given code will be searched for and, if found, deleted, before setting up a fresh journal