Add tutorial for adding users to ILS db #24
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ntarocco
reviewed
Jul 17, 2024
| @@ -0,0 +1,219 @@ | |||
| # Adding Users to Invenio ILS instance | |||
There was a problem hiding this comment.
We branded the products InvenioILS and InvenioRDM without spaces:
Suggested change
| # Adding Users to Invenio ILS instance | |
| # Adding users to InvenioILS instance |
Can you change it everywhere?
| @@ -0,0 +1,219 @@ | |||
| # Adding Users to Invenio ILS instance | |||
|
|
|||
| This guide provides step-by-step instructions for adding users to a custom Invenio App ILS instance using: | |||
There was a problem hiding this comment.
I am not 100% sure that readers know what is Invenio App ILS, given that we refer to it as InvenioILS:
Suggested change
| This guide provides step-by-step instructions for adding users to a custom Invenio App ILS instance using: | |
| This guide provides step-by-step instructions for adding users to your own InvenioILS instance using two possible different methods: |
|
|
||
| ### Prerequisites | ||
|
|
||
| - A running instance of Invenio App ILS. |
There was a problem hiding this comment.
Global change:
Suggested change
| - A running instance of Invenio App ILS. | |
| - A running instance of InvenioILS. |
|
|
||
| - A running instance of Invenio App ILS. | ||
| - Administrative access to the Invenio App ILS instance. | ||
| - Python installed on your system. |
There was a problem hiding this comment.
If I have the first, the second prerequisite must be there... I would remove the Python part
Comment on lines
+5
to
+6
| - An existing database | ||
| - LDAP synchronization |
There was a problem hiding this comment.
You are presenting the tutorial in the opposite order (first LDAP, then DB):
Suggested change
| - An existing database | |
| - LDAP synchronization | |
| 1. LDAP synchronization | |
| 2. An existing external database |
|
|
||
| ### Step 3: Create a Script to Port Users | ||
|
|
||
| Create a Python script to read users from the custom database and add them to the Invenio App ILS database. Save the following script as **port_users.py**: |
There was a problem hiding this comment.
Suggested change
| Create a Python script to read users from the custom database and add them to the Invenio App ILS database. Save the following script as **port_users.py**: | |
| Create a Python script to read users from the external database and add them to the InvenioILS database. Save the following script as **import_users.py**: |
| from invenio_app.factory import create_api | ||
|
|
||
| # Load configuration | ||
| custom_db_uri = os.getenv('CUSTOM_DB_URI', 'postgresql://user:password@localhost/customdb') |
There was a problem hiding this comment.
Apply everywhere
Suggested change
| custom_db_uri = os.getenv('CUSTOM_DB_URI', 'postgresql://user:password@localhost/customdb') | |
| external_db_uri = os.getenv('CUSTOM_DB_URI', 'postgresql://user:password@localhost/customdb') |
| metadata = MetaData() | ||
| users_table = Table('users', metadata, autoload_with=custom_engine) | ||
|
|
||
| def port_users(): |
There was a problem hiding this comment.
Suggested change
| def port_users(): | |
| def import_users(): |
| # Initialize Invenio app context | ||
| app = create_api() | ||
| with app.app_context(): | ||
| port_users() |
There was a problem hiding this comment.
Suggested change
| port_users() | |
| import_users() |
|
|
||
| ### Additional Tips | ||
|
|
||
| You may schedule the script to run periodically (e.g., using a cron job) if you need to keep the Invenio user database in sync with your custom database/LDAP directory. |
There was a problem hiding this comment.
Suggested change
| You may schedule the script to run periodically (e.g., using a cron job) if you need to keep the Invenio user database in sync with your custom database/LDAP directory. | |
| You may schedule the script to run periodically (e.g., using a cron job) if you need to keep the InvenioILS user database in sync with your external database or LDAP directory. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
(Not completely tested yet) [In progress]