From 9f97bb07b7e7c02fd8d6bc27a179d1a0cee57e9b Mon Sep 17 00:00:00 2001 From: Lekha Sapers Date: Tue, 6 Aug 2024 11:46:25 -0700 Subject: [PATCH] Deployed b0eb5d3 with MkDocs version: 1.6.0 --- index.html | 2 +- introduction/index.html | 43 +++++++++++++++++++++++++++++++++++++++- search/search_index.json | 2 +- 3 files changed, 44 insertions(+), 3 deletions(-) diff --git a/index.html b/index.html index 142ba8e..17ffa1c 100644 --- a/index.html +++ b/index.html @@ -214,5 +214,5 @@ diff --git a/introduction/index.html b/introduction/index.html index 3362b99..06c4259 100644 --- a/introduction/index.html +++ b/introduction/index.html @@ -111,6 +111,30 @@
  • Introduction +
    • + +
  • Clone the repository + +
    • + +
  • Navigate into the project directory + +
    • + +
  • Install dependencies + +
    • + +
  • Serve the site locally +
    • @@ -122,7 +146,24 @@

    Introduction

    The purpose of this documentation is to provide a comprehensive guide for using and managing the Omeka platform at 91.9 KCSB FM. Omeka is a web publishing platform ideal for sharing digital collections and creating media-rich online exhibits.

    This documentation covers everything from installation to advanced configuration and user management. It also delineates best practices for various website administrators, including the Archives Coordinator, Station Advisors, and Volunteers.

    The structure of this documentation is designed to facilitate ease of use, with sections dedicated to installation, configuration, user roles and permissions, content management, plugins and themes, backup and restore, maintenance and troubleshooting, and frequently asked questions (FAQ).

    -

    Please find the source code for this website at my repo.

    +

    Source Code

    +

    The source code for this MkDocs website is available on GitHub. You can view, clone, or contribute to the project by visiting the repository below:

    + +

    About the Project

    +

    This documentation site is built using MkDocs with the Flatly theme. It includes customizations for Google Analytics integration and additional CSS for improved styling.

    +

    Cloning the Repository

    +

    To clone the repository and run the site locally, follow these steps:

    +

    ```bash

    +

    Clone the repository

    +

    git clone https://github.com/lekhasapers/KCSB_OMEKA_Documentation.git

    +

    Navigate into the project directory

    +

    cd KCSB_OMEKA_Documentation

    +

    Install dependencies

    +

    pip install -r requirements.txt

    +

    Serve the site locally

    +

    mkdocs serve

    diff --git a/search/search_index.json b/search/search_index.json index 9883596..daff590 100644 --- a/search/search_index.json +++ b/search/search_index.json @@ -1 +1 @@ -{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"Omeka-S Documentation For 91.9 KCSB FM, 2024-2025 By Lekha Sapers Table of Contents Introduction System Requirements Installation Configuration User Guide Maintenance and Troubleshooting FAQ Appendix","title":"Home"},{"location":"#omeka-s-documentation","text":"","title":"Omeka-S Documentation"},{"location":"#for-919-kcsb-fm-2024-2025","text":"","title":"For 91.9 KCSB FM, 2024-2025"},{"location":"#by-lekha-sapers","text":"","title":"By Lekha Sapers"},{"location":"#table-of-contents","text":"Introduction System Requirements Installation Configuration User Guide Maintenance and Troubleshooting FAQ Appendix","title":"Table of Contents"},{"location":"appendices/","text":"Glossary API An Application Programming Interface (API) is a set of tools and protocols for building software and applications. Omeka S provides an API to allow developers to interact with and extend the platform programmatically. Archive A collection of historical records and documents that are preserved for research, historical, or cultural purposes. In Omeka, an archive can be digital, consisting of digitized or born-digital content. Collection A group of related items within Omeka that are organized under a specific theme or category. Collections help users navigate and discover content more efficiently. Cron Job A cron job is a scheduled task on Unix-like operating systems. It allows users to schedule scripts or commands to run automatically at specified times and intervals. Cron jobs are often used for automating repetitive tasks such as backups, updates, and system maintenance. CSV Import A module or plugin that allows users to upload items in bulk using CSV (Comma-Separated Values) files. This feature simplifies the process of adding large numbers of items and metadata to Omeka. Digital Collection A curated set of digital items, often organized around a specific theme, subject, or purpose. Digital collections in Omeka can include text, images, audio, and video content. Dublin Core A set of metadata elements used to describe digital resources. Omeka uses Dublin Core as its default metadata schema, which includes fields like Title, Subject, Description, Creator, and Date. Exhibit A curated presentation of items and collections in Omeka, designed to tell a story or provide insight into a particular topic. Exhibits can include text, images, and multimedia content to enhance the user's experience. Item A single piece of content in Omeka, such as a photograph, document, video, or audio file. Each item can be described using metadata fields and assigned to collections or exhibits. JSON-LD A lightweight data interchange format used to structure linked data in Omeka S. JSON-LD (JavaScript Object Notation for Linked Data) is used to represent complex metadata relationships. Linked Data A method of connecting and sharing structured data on the web, allowing for improved interoperability and discoverability. Omeka S supports linked data principles, enabling richer metadata connections. Metadata Information that describes a digital resource, such as title, creator, date, and format. Metadata helps users find and understand the context of digital items within Omeka. Module A software component that adds specific functionality to Omeka S, such as data import/export, user authentication, or visual customization. Modules can be installed and configured through the Omeka admin dashboard. Omeka Classic The original version of Omeka, designed for small to medium-sized digital collections. It offers basic features for item management, collection organization, and exhibit creation. Omeka S A more scalable and flexible version of Omeka, designed for larger institutions with multiple sites and collections. Omeka S supports linked data, advanced metadata schemas, and custom themes. Plugin An extension for Omeka Classic that adds additional features and capabilities, such as enhanced search, batch processing, or integration with other platforms. Resource Template In Omeka S, a predefined set of metadata fields used to create items with consistent descriptions. Resource templates help standardize data entry across collections and sites. SSH Key An SSH key is a pair of cryptographic keys used to authenticate and secure communication between computers over a network. The keys consist of a private key (kept secret) and a public key (shared with servers), providing a secure method of logging into a server remotely without a password. How to Create an SSH Key: Open a Terminal : Open a terminal on your local machine. Generate SSH Key : Use the following command to generate a new SSH key pair: sh ssh-keygen -t rsa -b 4096 -C \"your_email@example.com\" Replace \"your_email@example.com\" with your email address. Save the Key : When prompted, press Enter to save the key in the default location ( ~/.ssh/id_rsa ) or specify a different location. Set a Passphrase : Optionally, enter a passphrase for added security. Add SSH Key to SSH Agent : Start the SSH agent and add your SSH private key: sh eval \"$(ssh-agent -s)\" ssh-add ~/.ssh/id_rsa Copy Public Key to Clipboard : Use the following command to copy your public key to the clipboard: sh pbcopy < ~/.ssh/id_rsa.pub If pbcopy is not available, you can manually copy the key from the ~/.ssh/id_rsa.pub file. Add Public Key to Server : Add your SSH public key to the ~/.ssh/authorized_keys file on the server you want to access. Theme The visual design and layout of an Omeka site. Themes determine how content is displayed to users and can be customized or developed to fit the branding of an organization. User Role The permissions and access levels assigned to users within Omeka. Common roles include Administrator, Editor, and Viewer, each with different capabilities for managing content and settings. Quick Links For additional assistance, refer to the following resources: Omeka S Documentation : Access comprehensive user manuals and guides to help you navigate and make the most of Omeka S. Omeka Community Forums : Engage with the community, ask questions, and share knowledge about Omeka S. This is a great place to seek help from fellow users and experts. Project Documentation on Google Docs : As mentioned before, this sheet, from Yale University Library, is a goldmine of information. Please use. These resources provide valuable information and support to help you effectively use and troubleshoot Omeka S. Thanks for reading.","title":"Appendix"},{"location":"appendices/#glossary","text":"","title":"Glossary"},{"location":"appendices/#api","text":"An Application Programming Interface (API) is a set of tools and protocols for building software and applications. Omeka S provides an API to allow developers to interact with and extend the platform programmatically.","title":"API"},{"location":"appendices/#archive","text":"A collection of historical records and documents that are preserved for research, historical, or cultural purposes. In Omeka, an archive can be digital, consisting of digitized or born-digital content.","title":"Archive"},{"location":"appendices/#collection","text":"A group of related items within Omeka that are organized under a specific theme or category. Collections help users navigate and discover content more efficiently.","title":"Collection"},{"location":"appendices/#cron-job","text":"A cron job is a scheduled task on Unix-like operating systems. It allows users to schedule scripts or commands to run automatically at specified times and intervals. Cron jobs are often used for automating repetitive tasks such as backups, updates, and system maintenance.","title":"Cron Job"},{"location":"appendices/#csv-import","text":"A module or plugin that allows users to upload items in bulk using CSV (Comma-Separated Values) files. This feature simplifies the process of adding large numbers of items and metadata to Omeka.","title":"CSV Import"},{"location":"appendices/#digital-collection","text":"A curated set of digital items, often organized around a specific theme, subject, or purpose. Digital collections in Omeka can include text, images, audio, and video content.","title":"Digital Collection"},{"location":"appendices/#dublin-core","text":"A set of metadata elements used to describe digital resources. Omeka uses Dublin Core as its default metadata schema, which includes fields like Title, Subject, Description, Creator, and Date.","title":"Dublin Core"},{"location":"appendices/#exhibit","text":"A curated presentation of items and collections in Omeka, designed to tell a story or provide insight into a particular topic. Exhibits can include text, images, and multimedia content to enhance the user's experience.","title":"Exhibit"},{"location":"appendices/#item","text":"A single piece of content in Omeka, such as a photograph, document, video, or audio file. Each item can be described using metadata fields and assigned to collections or exhibits.","title":"Item"},{"location":"appendices/#json-ld","text":"A lightweight data interchange format used to structure linked data in Omeka S. JSON-LD (JavaScript Object Notation for Linked Data) is used to represent complex metadata relationships.","title":"JSON-LD"},{"location":"appendices/#linked-data","text":"A method of connecting and sharing structured data on the web, allowing for improved interoperability and discoverability. Omeka S supports linked data principles, enabling richer metadata connections.","title":"Linked Data"},{"location":"appendices/#metadata","text":"Information that describes a digital resource, such as title, creator, date, and format. Metadata helps users find and understand the context of digital items within Omeka.","title":"Metadata"},{"location":"appendices/#module","text":"A software component that adds specific functionality to Omeka S, such as data import/export, user authentication, or visual customization. Modules can be installed and configured through the Omeka admin dashboard.","title":"Module"},{"location":"appendices/#omeka-classic","text":"The original version of Omeka, designed for small to medium-sized digital collections. It offers basic features for item management, collection organization, and exhibit creation.","title":"Omeka Classic"},{"location":"appendices/#omeka-s","text":"A more scalable and flexible version of Omeka, designed for larger institutions with multiple sites and collections. Omeka S supports linked data, advanced metadata schemas, and custom themes.","title":"Omeka S"},{"location":"appendices/#plugin","text":"An extension for Omeka Classic that adds additional features and capabilities, such as enhanced search, batch processing, or integration with other platforms.","title":"Plugin"},{"location":"appendices/#resource-template","text":"In Omeka S, a predefined set of metadata fields used to create items with consistent descriptions. Resource templates help standardize data entry across collections and sites.","title":"Resource Template"},{"location":"appendices/#ssh-key","text":"An SSH key is a pair of cryptographic keys used to authenticate and secure communication between computers over a network. The keys consist of a private key (kept secret) and a public key (shared with servers), providing a secure method of logging into a server remotely without a password.","title":"SSH Key"},{"location":"appendices/#how-to-create-an-ssh-key","text":"Open a Terminal : Open a terminal on your local machine. Generate SSH Key : Use the following command to generate a new SSH key pair: sh ssh-keygen -t rsa -b 4096 -C \"your_email@example.com\" Replace \"your_email@example.com\" with your email address. Save the Key : When prompted, press Enter to save the key in the default location ( ~/.ssh/id_rsa ) or specify a different location. Set a Passphrase : Optionally, enter a passphrase for added security. Add SSH Key to SSH Agent : Start the SSH agent and add your SSH private key: sh eval \"$(ssh-agent -s)\" ssh-add ~/.ssh/id_rsa Copy Public Key to Clipboard : Use the following command to copy your public key to the clipboard: sh pbcopy < ~/.ssh/id_rsa.pub If pbcopy is not available, you can manually copy the key from the ~/.ssh/id_rsa.pub file. Add Public Key to Server : Add your SSH public key to the ~/.ssh/authorized_keys file on the server you want to access.","title":"How to Create an SSH Key:"},{"location":"appendices/#theme","text":"The visual design and layout of an Omeka site. Themes determine how content is displayed to users and can be customized or developed to fit the branding of an organization.","title":"Theme"},{"location":"appendices/#user-role","text":"The permissions and access levels assigned to users within Omeka. Common roles include Administrator, Editor, and Viewer, each with different capabilities for managing content and settings.","title":"User Role"},{"location":"appendices/#quick-links","text":"For additional assistance, refer to the following resources: Omeka S Documentation : Access comprehensive user manuals and guides to help you navigate and make the most of Omeka S. Omeka Community Forums : Engage with the community, ask questions, and share knowledge about Omeka S. This is a great place to seek help from fellow users and experts. Project Documentation on Google Docs : As mentioned before, this sheet, from Yale University Library, is a goldmine of information. Please use. These resources provide valuable information and support to help you effectively use and troubleshoot Omeka S. Thanks for reading.","title":"Quick Links"},{"location":"configuration/","text":"IV. Configuration After installing Omeka S on your server, the next step is to configure it properly to ensure optimal performance and security. This segment covers the initial configuration steps, configuring plugins and themes, and customizing the appearance of your Omeka S site. Initial Configuration Database Configuration During the web-based installation process, you will be prompted to enter the database connection details. Ensure you have the following information ready: Database Name: omeka_s Database User: omeka_user Database Password: password Database Host: localhost Fill in these details in the appropriate fields and proceed with the installation. Admin User Setup You will also be prompted to create an admin user during the installation process. This user will have full access to all administrative functions in Omeka S. Username: Choose a unique username. Email: Enter a valid email address. Password: Create a strong password. Site Configuration Once the installation is complete, log in to the admin interface using the credentials created in the previous step. Navigate to Settings to configure the basic settings of your Omeka S site, such as site title, site description, and administrative contact information. Configuring Plugins Plugins extend the functionality of Omeka S. The following details the installation procedures for themes and modules. Installing Plugins Download the desired plugin from the Omeka S plugin directory. Extract the plugin archive and upload the plugin folder to the modules directory in your Omeka S installation path ( /var/www/html/omeka-s/modules ). Ensure correct file permissions: sh sudo chown -R www-data:www-data /var/www/html/omeka-s/modules/PluginName sudo chmod -R 755 /var/www/html/omeka-s/modules/PluginName Activating Plugins Log in to the Omeka S admin interface. Navigate to Modules . Find the newly installed plugin and click Install . Once installed, click Activate to enable the plugin. Configuring Plugin Settings After activation, many plugins will add their own configuration options to the admin interface. Navigate to the plugin\u2019s configuration page via Modules > [Plugin Name] and configure the settings as needed. Configuring Themes Themes control the appearance of your Omeka S site. Here\u2019s how to install and customize themes: Installing Themes Download the desired theme from the Omeka S themes directory. Extract the theme archive and upload the theme folder to the themes directory in your Omeka S installation path /var/www/html/omeka-s/themes . Ensure the correct file permissions: sh sudo chown -R www-data:www-data /var/www/html/omeka-s/themes/ThemeName sudo chmod -R 755 /var/www/html/omeka-s/themes/ThemeName Activating Themes Log in to the Omeka S admin interface. Navigate to Appearance . Find the newly installed theme and click Activate . Customizing Themes Each theme may have its own set of customization options, such as logo upload, color schemes, and layout settings. Navigate to Appearance > Themes > Configure to access and modify these settings. To make deeper customizations, you can directly edit the theme\u2019s files in the themes directory.","title":"Configuration"},{"location":"configuration/#iv-configuration","text":"After installing Omeka S on your server, the next step is to configure it properly to ensure optimal performance and security. This segment covers the initial configuration steps, configuring plugins and themes, and customizing the appearance of your Omeka S site.","title":"IV. Configuration"},{"location":"configuration/#initial-configuration","text":"","title":"Initial Configuration"},{"location":"configuration/#database-configuration","text":"During the web-based installation process, you will be prompted to enter the database connection details. Ensure you have the following information ready: Database Name: omeka_s Database User: omeka_user Database Password: password Database Host: localhost Fill in these details in the appropriate fields and proceed with the installation.","title":"Database Configuration"},{"location":"configuration/#admin-user-setup","text":"You will also be prompted to create an admin user during the installation process. This user will have full access to all administrative functions in Omeka S. Username: Choose a unique username. Email: Enter a valid email address. Password: Create a strong password.","title":"Admin User Setup"},{"location":"configuration/#site-configuration","text":"Once the installation is complete, log in to the admin interface using the credentials created in the previous step. Navigate to Settings to configure the basic settings of your Omeka S site, such as site title, site description, and administrative contact information.","title":"Site Configuration"},{"location":"configuration/#configuring-plugins","text":"Plugins extend the functionality of Omeka S. The following details the installation procedures for themes and modules.","title":"Configuring Plugins"},{"location":"configuration/#installing-plugins","text":"Download the desired plugin from the Omeka S plugin directory. Extract the plugin archive and upload the plugin folder to the modules directory in your Omeka S installation path ( /var/www/html/omeka-s/modules ). Ensure correct file permissions: sh sudo chown -R www-data:www-data /var/www/html/omeka-s/modules/PluginName sudo chmod -R 755 /var/www/html/omeka-s/modules/PluginName","title":"Installing Plugins"},{"location":"configuration/#activating-plugins","text":"Log in to the Omeka S admin interface. Navigate to Modules . Find the newly installed plugin and click Install . Once installed, click Activate to enable the plugin.","title":"Activating Plugins"},{"location":"configuration/#configuring-plugin-settings","text":"After activation, many plugins will add their own configuration options to the admin interface. Navigate to the plugin\u2019s configuration page via Modules > [Plugin Name] and configure the settings as needed.","title":"Configuring Plugin Settings"},{"location":"configuration/#configuring-themes","text":"Themes control the appearance of your Omeka S site. Here\u2019s how to install and customize themes:","title":"Configuring Themes"},{"location":"configuration/#installing-themes","text":"Download the desired theme from the Omeka S themes directory. Extract the theme archive and upload the theme folder to the themes directory in your Omeka S installation path /var/www/html/omeka-s/themes . Ensure the correct file permissions: sh sudo chown -R www-data:www-data /var/www/html/omeka-s/themes/ThemeName sudo chmod -R 755 /var/www/html/omeka-s/themes/ThemeName","title":"Installing Themes"},{"location":"configuration/#activating-themes","text":"Log in to the Omeka S admin interface. Navigate to Appearance . Find the newly installed theme and click Activate .","title":"Activating Themes"},{"location":"configuration/#customizing-themes","text":"Each theme may have its own set of customization options, such as logo upload, color schemes, and layout settings. Navigate to Appearance > Themes > Configure to access and modify these settings. To make deeper customizations, you can directly edit the theme\u2019s files in the themes directory.","title":"Customizing Themes"},{"location":"faq/","text":"Frequently Asked Questions (FAQ) Here are some commonly asked questions and their answers to help you better understand and navigate the Omeka S documentation and platform. What is Omeka S? Omeka S is a web publishing platform designed for sharing and displaying digital collections. It is particularly useful for libraries, archives, museums, and scholarly projects looking to manage and present digital resources. How do I access the admin dashboard? To access the admin dashboard, navigate to archives.kcsb.org/admin . Enter your username and password to log in. If you have forgotten your credentials, click on \"Forgot Password\" to reset them. How can I import items using CSV files? Omeka S allows batch importing of items through CSV files. Navigate to the \"CSV Import\" module in the admin dashboard, upload your CSV file, and map the columns to Omeka S metadata fields. For more detailed instructions, refer to the Creating and Managing Content section. How do I customize the theme of my site? You can customize the appearance of your Omeka S site by selecting and configuring themes. Go to the \"Themes\" section in the admin dashboard, choose a theme, and activate it. For further customization, you can modify theme files directly or create custom CSS. Where can I find additional resources and support? For more information, refer to the Omeka S Documentation and participate in discussions on the Omeka Community Forums . Contact Me If you have any further questions or need assistance, feel free to contact me using the form below. xs Contact Form If you have any questions or feedback, feel free to contact me using the form below. Your Name Your Email Your Message Send","title":"FAQ"},{"location":"faq/#frequently-asked-questions-faq","text":"Here are some commonly asked questions and their answers to help you better understand and navigate the Omeka S documentation and platform.","title":"Frequently Asked Questions (FAQ)"},{"location":"faq/#what-is-omeka-s","text":"Omeka S is a web publishing platform designed for sharing and displaying digital collections. It is particularly useful for libraries, archives, museums, and scholarly projects looking to manage and present digital resources.","title":"What is Omeka S?"},{"location":"faq/#how-do-i-access-the-admin-dashboard","text":"To access the admin dashboard, navigate to archives.kcsb.org/admin . Enter your username and password to log in. If you have forgotten your credentials, click on \"Forgot Password\" to reset them.","title":"How do I access the admin dashboard?"},{"location":"faq/#how-can-i-import-items-using-csv-files","text":"Omeka S allows batch importing of items through CSV files. Navigate to the \"CSV Import\" module in the admin dashboard, upload your CSV file, and map the columns to Omeka S metadata fields. For more detailed instructions, refer to the Creating and Managing Content section.","title":"How can I import items using CSV files?"},{"location":"faq/#how-do-i-customize-the-theme-of-my-site","text":"You can customize the appearance of your Omeka S site by selecting and configuring themes. Go to the \"Themes\" section in the admin dashboard, choose a theme, and activate it. For further customization, you can modify theme files directly or create custom CSS.","title":"How do I customize the theme of my site?"},{"location":"faq/#where-can-i-find-additional-resources-and-support","text":"For more information, refer to the Omeka S Documentation and participate in discussions on the Omeka Community Forums .","title":"Where can I find additional resources and support?"},{"location":"faq/#contact-me","text":"If you have any further questions or need assistance, feel free to contact me using the form below. xs","title":"Contact Me"},{"location":"faq/#contact-form","text":"If you have any questions or feedback, feel free to contact me using the form below. Your Name Your Email Your Message Send","title":"Contact Form"},{"location":"installation/","text":"Omeka S and LAMP Stack Dependencies Running Omeka S on a LAMP backend architecture involves several steps, including installing and configuring each component of the stack and then installing Omeka S itself. 1. Install Elementary OS Install Elementary OS from the official website and follow the installation instructions. 2. Install Apache Install Apache HTTP Server: sh sudo apt update sudo apt install apache2 Enable mod_rewrite : sh sudo a2enmod rewrite sudo systemctl restart apache2 Verification: Open a web browser and navigate to http://localhost . This will prompt the Apache2 default welcome page. 3. Configure Firewall Allow HTTP and HTTPS traffic through the firewall: sh sudo ufw allow in \"Apache Full\" 4. Install MySQL Install MySQL Server: sh sudo apt install mysql-server sudo mysql_secure_installation Secure MySQL Installation: sh sudo mysql -u root -p Create a database and a user for Omeka-S: sql CREATE DATABASE omeka_s; CREATE USER 'omeka_user'@'localhost' IDENTIFIED BY 'password'; GRANT ALL PRIVILEGES ON omeka_s.* TO 'omeka_user'@'localhost'; FLUSH PRIVILEGES; EXIT; Verification: Log into MySQL and check the databases: sh sudo mysql -u root -p SHOW DATABASES; Ensure the Omeka-S database is listed. 5. Install PHP and Required Extensions Install PHP and required extensions: sh sudo apt install php libapache2-mod-php php-mysql php-json php-mbstring php-xml php-dom php-simplexml php-fileinfo php-curl php-gd Verification: Create a PHP File to verify installation: sh echo \"\" | sudo tee /var/www/html/info.php Navigate to http://localhost/info.php , where the PHP information page will be visible. 6. Advanced PHP Configuration Adjust PHP settings for better performance: sh sudo nano /etc/php/7.4/apache2/php.ini This subsequent part is very important and something that I had trouble with. Don't forget to do this. Suggested adjustments: memory_limit = 256M upload_max_filesize = 64M post_max_size = 64M max_execution_time = 300 7. Install Composer and Git Install Composer and Git: sh sudo apt install composer sudo apt install git Version Control Verification: sh composer --version git --version 8. Install Omeka S Navigate to the web root and clone the Omeka S repository: sh cd /var/www/html sudo git clone https://github.com/omeka/omeka-s.git 9. Set File Permissions Set the correct file permissions: sh sudo chown -R www-data:www-data /var/www/html/omeka-s sudo chmod -R 755 /var/www/html/omeka-s 10. Install Omeka S Dependencies with Composer Install dependencies: sh cd omeka-s sudo composer install 11. Create a Host Config for Apache Create a new virtual host configuration: sudo nano /etc/apache2/sites-available/omeka-s.conf Add the following content to the config file: ServerAdmin webmaster@localhost DocumentRoot /var/www/html/omeka-s Options Indexes FollowSymLinks AllowOverride All Require all granted ErrorLog ${APACHE_LOG_DIR}/error.log CustomLog ${APACHE_LOG_DIR}/access.log combined 12. Enable the Virtual Host and Restart Apache Enable the virtual host and restart Apache: sh sudo a2ensite omeka-s.conf sudo systemctl restart apache2 13. Finalize Omeka S Installation Open a web browser and navigate to http://your-server-ip/omeka-s Follow the on-screen instructions to complete the Omeka S setup, entering the database information created earlier. 14. Enable HTTPS (Optional) Install Certbot for SSL/TLS configuration: sh sudo apt install certbot python3-certbot-apache sudo certbot --apache Follow Certbot's instructions to obtain and install a free SSL certificate from Let's Encrypt. 15. Optimize MySQL Configuration Consider optimizing MySQL for better performance: sh sudo nano /etc/mysql/mysql.conf.d/mysqld.cnf Add or modify configurations like: ini innodb_buffer_pool_size = 1G query_cache_size = 64M query_cache_type = 1 16. Enable Error Logging for Debugging Ensure error logging is enabled to assist with troubleshooting: apache php_flag display_errors Off php_flag log_errors On php_value error_log /var/www/html/omeka-s/php_errors.log 17. Set Up Cron Jobs for Maintenance (Optional) I didn't do this, but in retrospect would be better to complete Set up cron jobs for regular maintenance tasks: sh crontab -e Add tasks such as: cron 0 3 * * * php /var/www/html/omeka-s/application/data/scripts/backup.php 18. Security Considerations Secure MySQL: Ensure proper security practices are followed, such as securing the MySQL root account and using strong passwords. 19. Backup Procedures Document a simple backup procedure for Omeka S data: sh mysqldump -u omeka_user -p omeka_s > /path/to/backup/omeka_s_backup.sql By following these steps and meeting the system requirements, Omeka S will be effectively installed and configured on a LAMP stack, providing a robust platform for managing and sharing digital collections at 91.9 KCSB FM.","title":"Installation"},{"location":"installation/#omeka-s-and-lamp-stack-dependencies","text":"Running Omeka S on a LAMP backend architecture involves several steps, including installing and configuring each component of the stack and then installing Omeka S itself.","title":"Omeka S and LAMP Stack Dependencies"},{"location":"installation/#1-install-elementary-os","text":"Install Elementary OS from the official website and follow the installation instructions.","title":"1. Install Elementary OS"},{"location":"installation/#2-install-apache","text":"Install Apache HTTP Server: sh sudo apt update sudo apt install apache2 Enable mod_rewrite : sh sudo a2enmod rewrite sudo systemctl restart apache2 Verification: Open a web browser and navigate to http://localhost . This will prompt the Apache2 default welcome page.","title":"2. Install Apache"},{"location":"installation/#3-configure-firewall","text":"Allow HTTP and HTTPS traffic through the firewall: sh sudo ufw allow in \"Apache Full\"","title":"3. Configure Firewall"},{"location":"installation/#4-install-mysql","text":"Install MySQL Server: sh sudo apt install mysql-server sudo mysql_secure_installation Secure MySQL Installation: sh sudo mysql -u root -p Create a database and a user for Omeka-S: sql CREATE DATABASE omeka_s; CREATE USER 'omeka_user'@'localhost' IDENTIFIED BY 'password'; GRANT ALL PRIVILEGES ON omeka_s.* TO 'omeka_user'@'localhost'; FLUSH PRIVILEGES; EXIT; Verification: Log into MySQL and check the databases: sh sudo mysql -u root -p SHOW DATABASES; Ensure the Omeka-S database is listed.","title":"4. Install MySQL"},{"location":"installation/#5-install-php-and-required-extensions","text":"Install PHP and required extensions: sh sudo apt install php libapache2-mod-php php-mysql php-json php-mbstring php-xml php-dom php-simplexml php-fileinfo php-curl php-gd Verification: Create a PHP File to verify installation: sh echo \"\" | sudo tee /var/www/html/info.php Navigate to http://localhost/info.php , where the PHP information page will be visible.","title":"5. Install PHP and Required Extensions"},{"location":"installation/#6-advanced-php-configuration","text":"Adjust PHP settings for better performance: sh sudo nano /etc/php/7.4/apache2/php.ini This subsequent part is very important and something that I had trouble with. Don't forget to do this. Suggested adjustments: memory_limit = 256M upload_max_filesize = 64M post_max_size = 64M max_execution_time = 300","title":"6. Advanced PHP Configuration"},{"location":"installation/#7-install-composer-and-git","text":"Install Composer and Git: sh sudo apt install composer sudo apt install git Version Control Verification: sh composer --version git --version","title":"7. Install Composer and Git"},{"location":"installation/#8-install-omeka-s","text":"Navigate to the web root and clone the Omeka S repository: sh cd /var/www/html sudo git clone https://github.com/omeka/omeka-s.git","title":"8. Install Omeka S"},{"location":"installation/#9-set-file-permissions","text":"Set the correct file permissions: sh sudo chown -R www-data:www-data /var/www/html/omeka-s sudo chmod -R 755 /var/www/html/omeka-s","title":"9. Set File Permissions"},{"location":"installation/#10-install-omeka-s-dependencies-with-composer","text":"Install dependencies: sh cd omeka-s sudo composer install","title":"10. Install Omeka S Dependencies with Composer"},{"location":"installation/#11-create-a-host-config-for-apache","text":"Create a new virtual host configuration: sudo nano /etc/apache2/sites-available/omeka-s.conf Add the following content to the config file: ServerAdmin webmaster@localhost DocumentRoot /var/www/html/omeka-s Options Indexes FollowSymLinks AllowOverride All Require all granted ErrorLog ${APACHE_LOG_DIR}/error.log CustomLog ${APACHE_LOG_DIR}/access.log combined ","title":"11. Create a Host Config for Apache"},{"location":"installation/#12-enable-the-virtual-host-and-restart-apache","text":"Enable the virtual host and restart Apache: sh sudo a2ensite omeka-s.conf sudo systemctl restart apache2","title":"12. Enable the Virtual Host and Restart Apache"},{"location":"installation/#13-finalize-omeka-s-installation","text":"Open a web browser and navigate to http://your-server-ip/omeka-s Follow the on-screen instructions to complete the Omeka S setup, entering the database information created earlier.","title":"13. Finalize Omeka S Installation"},{"location":"installation/#14-enable-https-optional","text":"Install Certbot for SSL/TLS configuration: sh sudo apt install certbot python3-certbot-apache sudo certbot --apache Follow Certbot's instructions to obtain and install a free SSL certificate from Let's Encrypt.","title":"14. Enable HTTPS (Optional)"},{"location":"installation/#15-optimize-mysql-configuration","text":"Consider optimizing MySQL for better performance: sh sudo nano /etc/mysql/mysql.conf.d/mysqld.cnf Add or modify configurations like: ini innodb_buffer_pool_size = 1G query_cache_size = 64M query_cache_type = 1","title":"15. Optimize MySQL Configuration"},{"location":"installation/#16-enable-error-logging-for-debugging","text":"Ensure error logging is enabled to assist with troubleshooting: apache php_flag display_errors Off php_flag log_errors On php_value error_log /var/www/html/omeka-s/php_errors.log","title":"16. Enable Error Logging for Debugging"},{"location":"installation/#17-set-up-cron-jobs-for-maintenance-optional","text":"I didn't do this, but in retrospect would be better to complete Set up cron jobs for regular maintenance tasks: sh crontab -e Add tasks such as: cron 0 3 * * * php /var/www/html/omeka-s/application/data/scripts/backup.php","title":"17. Set Up Cron Jobs for Maintenance (Optional)"},{"location":"installation/#18-security-considerations","text":"Secure MySQL: Ensure proper security practices are followed, such as securing the MySQL root account and using strong passwords.","title":"18. Security Considerations"},{"location":"installation/#19-backup-procedures","text":"Document a simple backup procedure for Omeka S data: sh mysqldump -u omeka_user -p omeka_s > /path/to/backup/omeka_s_backup.sql By following these steps and meeting the system requirements, Omeka S will be effectively installed and configured on a LAMP stack, providing a robust platform for managing and sharing digital collections at 91.9 KCSB FM.","title":"19. Backup Procedures"},{"location":"introduction/","text":"Introduction The purpose of this documentation is to provide a comprehensive guide for using and managing the Omeka platform at 91.9 KCSB FM. Omeka is a web publishing platform ideal for sharing digital collections and creating media-rich online exhibits. This documentation covers everything from installation to advanced configuration and user management. It also delineates best practices for various website administrators, including the Archives Coordinator, Station Advisors, and Volunteers. The structure of this documentation is designed to facilitate ease of use, with sections dedicated to installation, configuration, user roles and permissions, content management, plugins and themes, backup and restore, maintenance and troubleshooting, and frequently asked questions (FAQ). Please find the source code for this website at my repo.","title":"Introduction"},{"location":"introduction/#introduction","text":"The purpose of this documentation is to provide a comprehensive guide for using and managing the Omeka platform at 91.9 KCSB FM. Omeka is a web publishing platform ideal for sharing digital collections and creating media-rich online exhibits. This documentation covers everything from installation to advanced configuration and user management. It also delineates best practices for various website administrators, including the Archives Coordinator, Station Advisors, and Volunteers. The structure of this documentation is designed to facilitate ease of use, with sections dedicated to installation, configuration, user roles and permissions, content management, plugins and themes, backup and restore, maintenance and troubleshooting, and frequently asked questions (FAQ). Please find the source code for this website at my repo.","title":"Introduction"},{"location":"maintenance/","text":"Maintenance and Troubleshooting Keeping the LAMP Stack Updated To ensure the LAMP stack remains secure and compatible with Omeka S, follow these steps to keep your system and software updated: Update Package Lists sudo apt update Upgrade Installed Packages sudo apt upgrade Full Distribution Upgrade sudo apt dist-upgrade Version Control Maintenance Ensure appropriate versions for Apache, MySQL, PHP: sudo apt install apache2 mysql-server php Check for specific version updates: Apache: sh apache2 -v MySQL: sh mysql --version PHP: sh php -v Configure Automatic Security Updates Install unattended-upgrades package: sudo apt install unattended-upgrades Enable automatic updates: sudo dpkg-reconfigure --priority=low unattended-upgrades By following these guidelines, KCSB\u2019s Omeka LAMP stack will remain up to date and secure, minimizing the risk of deprecation and ensuring continued compatibility with Omeka S. Backing Up Omeka S Overview Backing up Omeka S involves two main components: 1. Omeka S Files : This includes the application files, configuration files, themes, plugins, and uploaded files. 2. Database : Omeka S uses a database (typically MySQL) to store all metadata, settings, and relationships. Both components must be backed up regularly to ensure a complete and restorable backup. Prerequisites Access to the server where Omeka S is installed. Administrative privileges to access files and databases. Basic knowledge of command-line operations Step 1: Backing Up Omeka S Files Manual Backup Connect to Your Server : Use SSH to connect to your server. I've been using 'archives@128.111.126.136', but I'm not sure if you're on the same computer, so you may have to set that up on your own. sh ssh username@your-server-ip Navigate to the Omeka S Directory : Locate the directory where Omeka S is installed. sh cd /var/www/html/omeka-s Create a Compressed Archive : Use the tar command to create a compressed archive of the Omeka S directory. sh tar -czvf omeka-s-backup-$(date +%F).tar.gz . This command creates a tar.gz file named with the current date. Move the Backup File : Move the backup file to a safe location. sh mv omeka-s-backup-$(date +%F).tar.gz /path/to/backup/location Automated Backup (Using a Cron Job) Create a Backup Script : Create a shell script to automate the backup process. sh nano backup-omeka-s.sh Add the following content to the script: sh #!/bin/bash BACKUP_DIR=\"/path/to/backup/location\" OMEKA_DIR=\"/path/to/omeka-s\" TIMESTAMP=$(date +%F) tar -czvf $BACKUP_DIR/omeka-s-backup-$TIMESTAMP.tar.gz -C $OMEKA_DIR . Save and close the file. Make the Script Executable : sh chmod +x backup-omeka-s.sh Create a Cron Job : Open the crontab editor. sh crontab -e Add the following line to schedule the backup script to run daily at midnight: sh 0 0 * * * /path/to/backup-omeka-s.sh Step 2: Backing Up the Database Manual Backup Dump the Database : Use the mysqldump command to create a backup of the Omeka S database. sh mysqldump -u username -p omeka_database > omeka-db-backup-$(date +%F).sql Enter your MySQL password when prompted. Move the Backup File : Move the SQL file to a safe location. sh mv omeka-db-backup-$(date +%F).sql /path/to/backup/location Automated Backup (Using a Cron Job) Create a Database Backup Script : Create a shell script to automate the database backup process. sh nano backup-omeka-db.sh Add the following content to the script: sh #!/bin/bash BACKUP_DIR=\"/path/to/backup/location\" DB_USER=\"username\" DB_PASS=\"password\" DB_NAME=\"omeka_database\" TIMESTAMP=$(date +%F) mysqldump -u $DB_USER -p$DB_PASS $DB_NAME > $BACKUP_DIR/omeka-db-backup-$TIMESTAMP.sql Save and close the file. Make the Script Executable : sh chmod +x backup-omeka-db.sh Create a Cron Job : Open the crontab editor. sh crontab -e Add the following line to schedule the database backup script to run daily at 1 AM: sh 0 1 * * * /path/to/backup-omeka-db.sh Step 3: Verifying Backups List Backup Files : Check the backup location to ensure the files are created. sh ls /path/to/backup/location Test Restoration : Periodically test the restoration process to ensure backups are valid and complete. Regularly backing up your Omeka S installation is critical for data integrity and disaster recovery. By following the steps outlined in this documentation, you can ensure that both your files and database are safely backed up and can be restored if needed.","title":"Maintenance"},{"location":"maintenance/#maintenance-and-troubleshooting","text":"","title":"Maintenance and Troubleshooting"},{"location":"maintenance/#keeping-the-lamp-stack-updated","text":"To ensure the LAMP stack remains secure and compatible with Omeka S, follow these steps to keep your system and software updated:","title":"Keeping the LAMP Stack Updated"},{"location":"maintenance/#update-package-lists","text":"sudo apt update","title":"Update Package Lists"},{"location":"maintenance/#upgrade-installed-packages","text":"sudo apt upgrade","title":"Upgrade Installed Packages"},{"location":"maintenance/#full-distribution-upgrade","text":"sudo apt dist-upgrade","title":"Full Distribution Upgrade"},{"location":"maintenance/#version-control-maintenance","text":"Ensure appropriate versions for Apache, MySQL, PHP: sudo apt install apache2 mysql-server php Check for specific version updates: Apache: sh apache2 -v MySQL: sh mysql --version PHP: sh php -v","title":"Version Control Maintenance"},{"location":"maintenance/#configure-automatic-security-updates","text":"Install unattended-upgrades package: sudo apt install unattended-upgrades Enable automatic updates: sudo dpkg-reconfigure --priority=low unattended-upgrades By following these guidelines, KCSB\u2019s Omeka LAMP stack will remain up to date and secure, minimizing the risk of deprecation and ensuring continued compatibility with Omeka S.","title":"Configure Automatic Security Updates"},{"location":"maintenance/#backing-up-omeka-s","text":"","title":"Backing Up Omeka S"},{"location":"maintenance/#overview","text":"Backing up Omeka S involves two main components: 1. Omeka S Files : This includes the application files, configuration files, themes, plugins, and uploaded files. 2. Database : Omeka S uses a database (typically MySQL) to store all metadata, settings, and relationships. Both components must be backed up regularly to ensure a complete and restorable backup.","title":"Overview"},{"location":"maintenance/#prerequisites","text":"Access to the server where Omeka S is installed. Administrative privileges to access files and databases. Basic knowledge of command-line operations","title":"Prerequisites"},{"location":"maintenance/#step-1-backing-up-omeka-s-files","text":"","title":"Step 1: Backing Up Omeka S Files"},{"location":"maintenance/#manual-backup","text":"Connect to Your Server : Use SSH to connect to your server. I've been using 'archives@128.111.126.136', but I'm not sure if you're on the same computer, so you may have to set that up on your own. sh ssh username@your-server-ip Navigate to the Omeka S Directory : Locate the directory where Omeka S is installed. sh cd /var/www/html/omeka-s Create a Compressed Archive : Use the tar command to create a compressed archive of the Omeka S directory. sh tar -czvf omeka-s-backup-$(date +%F).tar.gz . This command creates a tar.gz file named with the current date. Move the Backup File : Move the backup file to a safe location. sh mv omeka-s-backup-$(date +%F).tar.gz /path/to/backup/location","title":"Manual Backup"},{"location":"maintenance/#automated-backup-using-a-cron-job","text":"Create a Backup Script : Create a shell script to automate the backup process. sh nano backup-omeka-s.sh Add the following content to the script: sh #!/bin/bash BACKUP_DIR=\"/path/to/backup/location\" OMEKA_DIR=\"/path/to/omeka-s\" TIMESTAMP=$(date +%F) tar -czvf $BACKUP_DIR/omeka-s-backup-$TIMESTAMP.tar.gz -C $OMEKA_DIR . Save and close the file. Make the Script Executable : sh chmod +x backup-omeka-s.sh Create a Cron Job : Open the crontab editor. sh crontab -e Add the following line to schedule the backup script to run daily at midnight: sh 0 0 * * * /path/to/backup-omeka-s.sh","title":"Automated Backup (Using a Cron Job)"},{"location":"maintenance/#step-2-backing-up-the-database","text":"","title":"Step 2: Backing Up the Database"},{"location":"maintenance/#manual-backup_1","text":"Dump the Database : Use the mysqldump command to create a backup of the Omeka S database. sh mysqldump -u username -p omeka_database > omeka-db-backup-$(date +%F).sql Enter your MySQL password when prompted. Move the Backup File : Move the SQL file to a safe location. sh mv omeka-db-backup-$(date +%F).sql /path/to/backup/location","title":"Manual Backup"},{"location":"maintenance/#automated-backup-using-a-cron-job_1","text":"Create a Database Backup Script : Create a shell script to automate the database backup process. sh nano backup-omeka-db.sh Add the following content to the script: sh #!/bin/bash BACKUP_DIR=\"/path/to/backup/location\" DB_USER=\"username\" DB_PASS=\"password\" DB_NAME=\"omeka_database\" TIMESTAMP=$(date +%F) mysqldump -u $DB_USER -p$DB_PASS $DB_NAME > $BACKUP_DIR/omeka-db-backup-$TIMESTAMP.sql Save and close the file. Make the Script Executable : sh chmod +x backup-omeka-db.sh Create a Cron Job : Open the crontab editor. sh crontab -e Add the following line to schedule the database backup script to run daily at 1 AM: sh 0 1 * * * /path/to/backup-omeka-db.sh","title":"Automated Backup (Using a Cron Job)"},{"location":"maintenance/#step-3-verifying-backups","text":"List Backup Files : Check the backup location to ensure the files are created. sh ls /path/to/backup/location Test Restoration : Periodically test the restoration process to ensure backups are valid and complete. Regularly backing up your Omeka S installation is critical for data integrity and disaster recovery. By following the steps outlined in this documentation, you can ensure that both your files and database are safely backed up and can be restored if needed.","title":"Step 3: Verifying Backups"},{"location":"system-requirements/","text":"System Requirements To ensure the Omeka S platform operates efficiently at 91.9 KCSB FM, it is essential to meet the following system requirements. These requirements cover both the server environment and required software dependencies. Server Requirements Operating System: - Elementary OS Hardware: Processor: Ideally 1 GHz or faster Memory: 2 GB RAM MINIMUM (4+ GB recommended) Storage: 20GB+ Disk Space Network: Reliable internet connection Software Dependencies Omeka S is run with a LAMP stack backend architecture. The software requirements are detailed below: Linux Elementary OS (Ubuntu): Ensure that your system is up-to-date to avoid security vulnerabilities and compatibility issues. Apache Apache HTTP Server 2.4 or higher Ensure mod_rewrite is enabled MySQL MySQL 5.7 or higher or MariaDB 10.1 or higher Recommended: InnoDB storage engine for tables to increase efficiency and provide foreign key support Must be configured to handle UTF-8 encoding: sql ALTER DATABASE your_database_name CHARACTER SET = utf8mb4 COLLATE = utf8mb4_unicode_ci; MySQL default collation/character set is generally utf8mb4 and utf8mb4_0900_ai_ci , but double-check to ensure. PHP PHP 7.4 or higher Required PHP extensions: PDO , pdo_mysql , mysqli , json , mbstring , xml , dom , simplexml , fileinfo , curl , gd Install required PHP extensions: sh sudo apt install php libapache2-mod-php php-mysql php-json php-mbstring php-xml php-dom php-simplexml php-fileinfo php-curl php-gd Additional Software Composer (for PHP dependencies) Git (for version control) SSL Certificate","title":"System Requirements"},{"location":"system-requirements/#system-requirements","text":"To ensure the Omeka S platform operates efficiently at 91.9 KCSB FM, it is essential to meet the following system requirements. These requirements cover both the server environment and required software dependencies.","title":"System Requirements"},{"location":"system-requirements/#server-requirements","text":"Operating System: - Elementary OS Hardware: Processor: Ideally 1 GHz or faster Memory: 2 GB RAM MINIMUM (4+ GB recommended) Storage: 20GB+ Disk Space Network: Reliable internet connection","title":"Server Requirements"},{"location":"system-requirements/#software-dependencies","text":"Omeka S is run with a LAMP stack backend architecture. The software requirements are detailed below:","title":"Software Dependencies"},{"location":"system-requirements/#linux","text":"Elementary OS (Ubuntu): Ensure that your system is up-to-date to avoid security vulnerabilities and compatibility issues.","title":"Linux"},{"location":"system-requirements/#apache","text":"Apache HTTP Server 2.4 or higher Ensure mod_rewrite is enabled","title":"Apache"},{"location":"system-requirements/#mysql","text":"MySQL 5.7 or higher or MariaDB 10.1 or higher Recommended: InnoDB storage engine for tables to increase efficiency and provide foreign key support Must be configured to handle UTF-8 encoding: sql ALTER DATABASE your_database_name CHARACTER SET = utf8mb4 COLLATE = utf8mb4_unicode_ci; MySQL default collation/character set is generally utf8mb4 and utf8mb4_0900_ai_ci , but double-check to ensure.","title":"MySQL"},{"location":"system-requirements/#php","text":"PHP 7.4 or higher Required PHP extensions: PDO , pdo_mysql , mysqli , json , mbstring , xml , dom , simplexml , fileinfo , curl , gd Install required PHP extensions: sh sudo apt install php libapache2-mod-php php-mysql php-json php-mbstring php-xml php-dom php-simplexml php-fileinfo php-curl php-gd","title":"PHP"},{"location":"system-requirements/#additional-software","text":"Composer (for PHP dependencies) Git (for version control) SSL Certificate","title":"Additional Software"},{"location":"user-guide/","text":"User Guide This section provides guidance on accessing and using the Omeka S website. Accessing the Website To access the Omeka S website, visit archives.kcsb.org . Accessing the Administrative Back-End The Omeka S administrative back-end is designed for managing collections, configuring settings, and overseeing the content displayed on your website. Here\u2019s how to access and navigate the admin dashboard: Visit the Admin Dashboard Go to archives.kcsb.org/admin . You will be prompted to log in with your administrative credentials. Login Credentials You will be prompted to log in with your administrative credentials. Enter your username and password to access the admin dashboard. If you have forgotten your password, use the \"Forgot Password\" link to reset it. Admin Dashboard Overview Once logged in, you will be taken to the main dashboard, which provides a quick overview of the site\u2019s activity and shortcuts to frequently used features. Navigation Menu The navigation menu on the left side of the dashboard allows you to access different sections: Items: Manage digital items in your collection, including adding, editing, and deleting items. Item Sets: Organize items into sets for better categorization and retrieval. Media: Upload and manage media files such as images, audio, and video associated with your items. Pages: Create and edit site pages to provide additional information and context for your collections. Users: Manage user accounts, assign roles, and set permissions. Modules: Add functionality to your Omeka S installation through various modules and plugins. Settings: Configure site-wide settings such as themes, languages, and API settings. User Roles and Permissions Omeka S supports multiple user roles, each with specific permissions: Global Administrator: Full access to all settings and content management features. This category will generally include the Engineer, Assistant Engineer, and the Archives Coordinator Supervisor: Manage content but with limited access to site-wide settings. This category will generally include the Advisors. Editor: Create and edit items and item sets but cannot change global settings. This category will generally include the experienced Archives volunteers Reviewer: Has content privileges but can only delete their own content. This category will generally include Archives volunteers. Author Can create their own content. This category will generally include beginner Archives volunteers. Researcher: Access public and private items for research purposes. This category will include the general public. Creating and Managing Content As indicated before, The content in Omeka S is organized into Items , Item Sets , and Media . This section explains how to create and manage these content types efficiently. There are also parameters to manage Users , which this section will review in depth. Adding Items Navigate to the \"Items\" Section: Access this section from the navigation menu on the left. Click \"Add New Item\": This opens the item creation form. Enter Item Details: Fill in fields such as title, description, and metadata. Attach Media Files: Upload associated files like images, audio, and video. Save the Item: Click \"Save\" to add the item to your collection. Adding a New Item Navigate to the \"Items\" section. Click \"Add New Item.\" Enter item details, such as title, description, and associated media. Save the item. Creating Item Sets Item Sets are groups of related items. They help organize collections. Go to \"Item Sets\": Access this section via the navigation menu. Click \"Add New Item Set\": This opens the item set creation form. Enter Set Details: Provide a title, description, and any relevant metadata. Add Items to the Set: Select items to include in the set. Save the Item Set: Click \"Save\" to create the item set. Managing Media Media management is critical for associating files with items. Upload Media Files: Access the \"Media\" section and click \"Add New Media.\" Select Files to Upload: Choose files from your computer or provide a URL for external media. Link Media to Items: Assign media to items, specifying their role (e.g., image, audio). Managing Users Access the \"Users\" section. Click \"Add New User\" to create a user account. Assign a role and set permissions for the user. Save the user account. CSV Upload A critical part of the KCSB content management workflow is the CSV upload module. Procedures and best practices will also be reviewed in this section. KCSB Spreadsheet Template: A template for preparing your CSV file is available to assist you. The KCSB Spreadsheet can be found here . Prepare Your CSV File: Format: Ensure your CSV file is formatted correctly, with column headers matching Omeka S metadata fields (e.g., title, description, creator). Include Media URLs: This has not been something I've been able to figure out, as there's a roadblock with linking URLs from Google Drive. However, if you find a way around it, please change my documentation so future archivists don't have to manually upload files. Navigate to CSV Import: Access the \"CSV Import\" module from the admin dashboard. Click \"Import CSV\" to begin the upload process. Upload the CSV File: Select File: Choose the CSV file from your computer. Configure Mapping: Map CSV columns to Omeka S fields. Ensure each column is correctly matched to a metadata field. Review and Confirm: Preview: Check the preview to ensure data is correctly mapped. Import: Click \"Import\" to add items to the collection. Monitor the import progress. Verify Import: Check Items: Ensure all items have been imported correctly. Review Media: Verify that media files are associated with the correct items. Modules and Extensions Omeka S allows for the integration of modules that extend the platform\u2019s functionality. Common modules include: CSV Import: Import items and metadata from CSV files. Search: Enhance search capabilities for users. Mapping: Display items on geographical maps. Contact Us Adds a contact form to front-end site Contact Us Module The Contact Us module adds a contact form to your site, allowing visitors to get in touch easily. For more information, refer to Omeka's technical documentation. This step has already been completed, but in the case that it needs to be reinstalled, please refer to the below instructions. Download and Install: Obtain the module from the Omeka S repository and install it via the admin dashboard. Configure Settings: Set up email addresses and form fields according to your needs. Add Contact Us Page: Navigate to Pages: Access the \"Pages\" section from the dashboard. Create New Page: Click \"Add New Page\" and select the Contact Us layout. Customize Form: Adjust form fields and settings as needed. Publish Page: Click \"Save\" to publish the Contact Us page. Verify: Test the form to ensure it functions correctly and that messages are received. As mentioned above, the KCSB module is already functioning, but feel free to remove and redownload using the above steps if anything ever goes wrong with module ops. Themes Themes control the visual appearance of your Omeka S site. They can be customized to align with your branding and design preferences. Changing Themes Navigate to \"Themes\": Access this section from the admin dashboard. Select a Theme: Choose from available themes or upload a custom theme. Activate Theme: Click \"Activate\" to apply the theme to your site. Backup and Security Regularly back up your database and files to prevent data loss. Implement security best practices, such as using strong passwords and updating software regularly. Getting Help For additional assistance, refer to the Omeka S Documentation or seek help from the community forums . A wonderful resource that was my personal Omeka bible was the Yale University Archives Study Guide . Use this resource frequently!","title":"User Guide"},{"location":"user-guide/#user-guide","text":"This section provides guidance on accessing and using the Omeka S website.","title":"User Guide"},{"location":"user-guide/#accessing-the-website","text":"To access the Omeka S website, visit archives.kcsb.org .","title":"Accessing the Website"},{"location":"user-guide/#accessing-the-administrative-back-end","text":"The Omeka S administrative back-end is designed for managing collections, configuring settings, and overseeing the content displayed on your website. Here\u2019s how to access and navigate the admin dashboard:","title":"Accessing the Administrative Back-End"},{"location":"user-guide/#visit-the-admin-dashboard","text":"Go to archives.kcsb.org/admin . You will be prompted to log in with your administrative credentials.","title":"Visit the Admin Dashboard"},{"location":"user-guide/#login-credentials","text":"You will be prompted to log in with your administrative credentials. Enter your username and password to access the admin dashboard. If you have forgotten your password, use the \"Forgot Password\" link to reset it.","title":"Login Credentials"},{"location":"user-guide/#admin-dashboard-overview","text":"Once logged in, you will be taken to the main dashboard, which provides a quick overview of the site\u2019s activity and shortcuts to frequently used features.","title":"Admin Dashboard Overview"},{"location":"user-guide/#navigation-menu","text":"The navigation menu on the left side of the dashboard allows you to access different sections: Items: Manage digital items in your collection, including adding, editing, and deleting items. Item Sets: Organize items into sets for better categorization and retrieval. Media: Upload and manage media files such as images, audio, and video associated with your items. Pages: Create and edit site pages to provide additional information and context for your collections. Users: Manage user accounts, assign roles, and set permissions. Modules: Add functionality to your Omeka S installation through various modules and plugins. Settings: Configure site-wide settings such as themes, languages, and API settings.","title":"Navigation Menu"},{"location":"user-guide/#user-roles-and-permissions","text":"Omeka S supports multiple user roles, each with specific permissions: Global Administrator: Full access to all settings and content management features. This category will generally include the Engineer, Assistant Engineer, and the Archives Coordinator Supervisor: Manage content but with limited access to site-wide settings. This category will generally include the Advisors. Editor: Create and edit items and item sets but cannot change global settings. This category will generally include the experienced Archives volunteers Reviewer: Has content privileges but can only delete their own content. This category will generally include Archives volunteers. Author Can create their own content. This category will generally include beginner Archives volunteers. Researcher: Access public and private items for research purposes. This category will include the general public.","title":"User Roles and Permissions"},{"location":"user-guide/#creating-and-managing-content","text":"As indicated before, The content in Omeka S is organized into Items , Item Sets , and Media . This section explains how to create and manage these content types efficiently. There are also parameters to manage Users , which this section will review in depth.","title":"Creating and Managing Content"},{"location":"user-guide/#adding-items","text":"Navigate to the \"Items\" Section: Access this section from the navigation menu on the left. Click \"Add New Item\": This opens the item creation form. Enter Item Details: Fill in fields such as title, description, and metadata. Attach Media Files: Upload associated files like images, audio, and video. Save the Item: Click \"Save\" to add the item to your collection.","title":"Adding Items"},{"location":"user-guide/#adding-a-new-item","text":"Navigate to the \"Items\" section. Click \"Add New Item.\" Enter item details, such as title, description, and associated media. Save the item.","title":"Adding a New Item"},{"location":"user-guide/#creating-item-sets","text":"Item Sets are groups of related items. They help organize collections. Go to \"Item Sets\": Access this section via the navigation menu. Click \"Add New Item Set\": This opens the item set creation form. Enter Set Details: Provide a title, description, and any relevant metadata. Add Items to the Set: Select items to include in the set. Save the Item Set: Click \"Save\" to create the item set.","title":"Creating Item Sets"},{"location":"user-guide/#managing-media","text":"Media management is critical for associating files with items. Upload Media Files: Access the \"Media\" section and click \"Add New Media.\" Select Files to Upload: Choose files from your computer or provide a URL for external media. Link Media to Items: Assign media to items, specifying their role (e.g., image, audio).","title":"Managing Media"},{"location":"user-guide/#managing-users","text":"Access the \"Users\" section. Click \"Add New User\" to create a user account. Assign a role and set permissions for the user. Save the user account.","title":"Managing Users"},{"location":"user-guide/#csv-upload","text":"A critical part of the KCSB content management workflow is the CSV upload module. Procedures and best practices will also be reviewed in this section.","title":"CSV Upload"},{"location":"user-guide/#kcsb-spreadsheet-template","text":"A template for preparing your CSV file is available to assist you. The KCSB Spreadsheet can be found here .","title":"KCSB Spreadsheet Template:"},{"location":"user-guide/#prepare-your-csv-file","text":"Format: Ensure your CSV file is formatted correctly, with column headers matching Omeka S metadata fields (e.g., title, description, creator). Include Media URLs: This has not been something I've been able to figure out, as there's a roadblock with linking URLs from Google Drive. However, if you find a way around it, please change my documentation so future archivists don't have to manually upload files.","title":"Prepare Your CSV File:"},{"location":"user-guide/#navigate-to-csv-import","text":"Access the \"CSV Import\" module from the admin dashboard. Click \"Import CSV\" to begin the upload process.","title":"Navigate to CSV Import:"},{"location":"user-guide/#upload-the-csv-file","text":"Select File: Choose the CSV file from your computer. Configure Mapping: Map CSV columns to Omeka S fields. Ensure each column is correctly matched to a metadata field.","title":"Upload the CSV File:"},{"location":"user-guide/#review-and-confirm","text":"Preview: Check the preview to ensure data is correctly mapped. Import: Click \"Import\" to add items to the collection. Monitor the import progress.","title":"Review and Confirm:"},{"location":"user-guide/#verify-import","text":"Check Items: Ensure all items have been imported correctly. Review Media: Verify that media files are associated with the correct items.","title":"Verify Import:"},{"location":"user-guide/#modules-and-extensions","text":"Omeka S allows for the integration of modules that extend the platform\u2019s functionality. Common modules include: CSV Import: Import items and metadata from CSV files. Search: Enhance search capabilities for users. Mapping: Display items on geographical maps. Contact Us Adds a contact form to front-end site","title":"Modules and Extensions"},{"location":"user-guide/#contact-us-module","text":"The Contact Us module adds a contact form to your site, allowing visitors to get in touch easily. For more information, refer to Omeka's technical documentation. This step has already been completed, but in the case that it needs to be reinstalled, please refer to the below instructions. Download and Install: Obtain the module from the Omeka S repository and install it via the admin dashboard. Configure Settings: Set up email addresses and form fields according to your needs.","title":"Contact Us Module"},{"location":"user-guide/#add-contact-us-page","text":"Navigate to Pages: Access the \"Pages\" section from the dashboard. Create New Page: Click \"Add New Page\" and select the Contact Us layout. Customize Form: Adjust form fields and settings as needed. Publish Page: Click \"Save\" to publish the Contact Us page. Verify: Test the form to ensure it functions correctly and that messages are received. As mentioned above, the KCSB module is already functioning, but feel free to remove and redownload using the above steps if anything ever goes wrong with module ops.","title":"Add Contact Us Page:"},{"location":"user-guide/#themes","text":"Themes control the visual appearance of your Omeka S site. They can be customized to align with your branding and design preferences.","title":"Themes"},{"location":"user-guide/#changing-themes","text":"Navigate to \"Themes\": Access this section from the admin dashboard. Select a Theme: Choose from available themes or upload a custom theme. Activate Theme: Click \"Activate\" to apply the theme to your site.","title":"Changing Themes"},{"location":"user-guide/#backup-and-security","text":"Regularly back up your database and files to prevent data loss. Implement security best practices, such as using strong passwords and updating software regularly.","title":"Backup and Security"},{"location":"user-guide/#getting-help","text":"For additional assistance, refer to the Omeka S Documentation or seek help from the community forums . A wonderful resource that was my personal Omeka bible was the Yale University Archives Study Guide . Use this resource frequently!","title":"Getting Help"}]} \ No newline at end of file +{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"Omeka-S Documentation For 91.9 KCSB FM, 2024-2025 By Lekha Sapers Table of Contents Introduction System Requirements Installation Configuration User Guide Maintenance and Troubleshooting FAQ Appendix","title":"Home"},{"location":"#omeka-s-documentation","text":"","title":"Omeka-S Documentation"},{"location":"#for-919-kcsb-fm-2024-2025","text":"","title":"For 91.9 KCSB FM, 2024-2025"},{"location":"#by-lekha-sapers","text":"","title":"By Lekha Sapers"},{"location":"#table-of-contents","text":"Introduction System Requirements Installation Configuration User Guide Maintenance and Troubleshooting FAQ Appendix","title":"Table of Contents"},{"location":"appendices/","text":"Glossary API An Application Programming Interface (API) is a set of tools and protocols for building software and applications. Omeka S provides an API to allow developers to interact with and extend the platform programmatically. Archive A collection of historical records and documents that are preserved for research, historical, or cultural purposes. In Omeka, an archive can be digital, consisting of digitized or born-digital content. Collection A group of related items within Omeka that are organized under a specific theme or category. Collections help users navigate and discover content more efficiently. Cron Job A cron job is a scheduled task on Unix-like operating systems. It allows users to schedule scripts or commands to run automatically at specified times and intervals. Cron jobs are often used for automating repetitive tasks such as backups, updates, and system maintenance. CSV Import A module or plugin that allows users to upload items in bulk using CSV (Comma-Separated Values) files. This feature simplifies the process of adding large numbers of items and metadata to Omeka. Digital Collection A curated set of digital items, often organized around a specific theme, subject, or purpose. Digital collections in Omeka can include text, images, audio, and video content. Dublin Core A set of metadata elements used to describe digital resources. Omeka uses Dublin Core as its default metadata schema, which includes fields like Title, Subject, Description, Creator, and Date. Exhibit A curated presentation of items and collections in Omeka, designed to tell a story or provide insight into a particular topic. Exhibits can include text, images, and multimedia content to enhance the user's experience. Item A single piece of content in Omeka, such as a photograph, document, video, or audio file. Each item can be described using metadata fields and assigned to collections or exhibits. JSON-LD A lightweight data interchange format used to structure linked data in Omeka S. JSON-LD (JavaScript Object Notation for Linked Data) is used to represent complex metadata relationships. Linked Data A method of connecting and sharing structured data on the web, allowing for improved interoperability and discoverability. Omeka S supports linked data principles, enabling richer metadata connections. Metadata Information that describes a digital resource, such as title, creator, date, and format. Metadata helps users find and understand the context of digital items within Omeka. Module A software component that adds specific functionality to Omeka S, such as data import/export, user authentication, or visual customization. Modules can be installed and configured through the Omeka admin dashboard. Omeka Classic The original version of Omeka, designed for small to medium-sized digital collections. It offers basic features for item management, collection organization, and exhibit creation. Omeka S A more scalable and flexible version of Omeka, designed for larger institutions with multiple sites and collections. Omeka S supports linked data, advanced metadata schemas, and custom themes. Plugin An extension for Omeka Classic that adds additional features and capabilities, such as enhanced search, batch processing, or integration with other platforms. Resource Template In Omeka S, a predefined set of metadata fields used to create items with consistent descriptions. Resource templates help standardize data entry across collections and sites. SSH Key An SSH key is a pair of cryptographic keys used to authenticate and secure communication between computers over a network. The keys consist of a private key (kept secret) and a public key (shared with servers), providing a secure method of logging into a server remotely without a password. How to Create an SSH Key: Open a Terminal : Open a terminal on your local machine. Generate SSH Key : Use the following command to generate a new SSH key pair: sh ssh-keygen -t rsa -b 4096 -C \"your_email@example.com\" Replace \"your_email@example.com\" with your email address. Save the Key : When prompted, press Enter to save the key in the default location ( ~/.ssh/id_rsa ) or specify a different location. Set a Passphrase : Optionally, enter a passphrase for added security. Add SSH Key to SSH Agent : Start the SSH agent and add your SSH private key: sh eval \"$(ssh-agent -s)\" ssh-add ~/.ssh/id_rsa Copy Public Key to Clipboard : Use the following command to copy your public key to the clipboard: sh pbcopy < ~/.ssh/id_rsa.pub If pbcopy is not available, you can manually copy the key from the ~/.ssh/id_rsa.pub file. Add Public Key to Server : Add your SSH public key to the ~/.ssh/authorized_keys file on the server you want to access. Theme The visual design and layout of an Omeka site. Themes determine how content is displayed to users and can be customized or developed to fit the branding of an organization. User Role The permissions and access levels assigned to users within Omeka. Common roles include Administrator, Editor, and Viewer, each with different capabilities for managing content and settings. Quick Links For additional assistance, refer to the following resources: Omeka S Documentation : Access comprehensive user manuals and guides to help you navigate and make the most of Omeka S. Omeka Community Forums : Engage with the community, ask questions, and share knowledge about Omeka S. This is a great place to seek help from fellow users and experts. Project Documentation on Google Docs : As mentioned before, this sheet, from Yale University Library, is a goldmine of information. Please use. These resources provide valuable information and support to help you effectively use and troubleshoot Omeka S. Thanks for reading.","title":"Appendix"},{"location":"appendices/#glossary","text":"","title":"Glossary"},{"location":"appendices/#api","text":"An Application Programming Interface (API) is a set of tools and protocols for building software and applications. Omeka S provides an API to allow developers to interact with and extend the platform programmatically.","title":"API"},{"location":"appendices/#archive","text":"A collection of historical records and documents that are preserved for research, historical, or cultural purposes. In Omeka, an archive can be digital, consisting of digitized or born-digital content.","title":"Archive"},{"location":"appendices/#collection","text":"A group of related items within Omeka that are organized under a specific theme or category. Collections help users navigate and discover content more efficiently.","title":"Collection"},{"location":"appendices/#cron-job","text":"A cron job is a scheduled task on Unix-like operating systems. It allows users to schedule scripts or commands to run automatically at specified times and intervals. Cron jobs are often used for automating repetitive tasks such as backups, updates, and system maintenance.","title":"Cron Job"},{"location":"appendices/#csv-import","text":"A module or plugin that allows users to upload items in bulk using CSV (Comma-Separated Values) files. This feature simplifies the process of adding large numbers of items and metadata to Omeka.","title":"CSV Import"},{"location":"appendices/#digital-collection","text":"A curated set of digital items, often organized around a specific theme, subject, or purpose. Digital collections in Omeka can include text, images, audio, and video content.","title":"Digital Collection"},{"location":"appendices/#dublin-core","text":"A set of metadata elements used to describe digital resources. Omeka uses Dublin Core as its default metadata schema, which includes fields like Title, Subject, Description, Creator, and Date.","title":"Dublin Core"},{"location":"appendices/#exhibit","text":"A curated presentation of items and collections in Omeka, designed to tell a story or provide insight into a particular topic. Exhibits can include text, images, and multimedia content to enhance the user's experience.","title":"Exhibit"},{"location":"appendices/#item","text":"A single piece of content in Omeka, such as a photograph, document, video, or audio file. Each item can be described using metadata fields and assigned to collections or exhibits.","title":"Item"},{"location":"appendices/#json-ld","text":"A lightweight data interchange format used to structure linked data in Omeka S. JSON-LD (JavaScript Object Notation for Linked Data) is used to represent complex metadata relationships.","title":"JSON-LD"},{"location":"appendices/#linked-data","text":"A method of connecting and sharing structured data on the web, allowing for improved interoperability and discoverability. Omeka S supports linked data principles, enabling richer metadata connections.","title":"Linked Data"},{"location":"appendices/#metadata","text":"Information that describes a digital resource, such as title, creator, date, and format. Metadata helps users find and understand the context of digital items within Omeka.","title":"Metadata"},{"location":"appendices/#module","text":"A software component that adds specific functionality to Omeka S, such as data import/export, user authentication, or visual customization. Modules can be installed and configured through the Omeka admin dashboard.","title":"Module"},{"location":"appendices/#omeka-classic","text":"The original version of Omeka, designed for small to medium-sized digital collections. It offers basic features for item management, collection organization, and exhibit creation.","title":"Omeka Classic"},{"location":"appendices/#omeka-s","text":"A more scalable and flexible version of Omeka, designed for larger institutions with multiple sites and collections. Omeka S supports linked data, advanced metadata schemas, and custom themes.","title":"Omeka S"},{"location":"appendices/#plugin","text":"An extension for Omeka Classic that adds additional features and capabilities, such as enhanced search, batch processing, or integration with other platforms.","title":"Plugin"},{"location":"appendices/#resource-template","text":"In Omeka S, a predefined set of metadata fields used to create items with consistent descriptions. Resource templates help standardize data entry across collections and sites.","title":"Resource Template"},{"location":"appendices/#ssh-key","text":"An SSH key is a pair of cryptographic keys used to authenticate and secure communication between computers over a network. The keys consist of a private key (kept secret) and a public key (shared with servers), providing a secure method of logging into a server remotely without a password.","title":"SSH Key"},{"location":"appendices/#how-to-create-an-ssh-key","text":"Open a Terminal : Open a terminal on your local machine. Generate SSH Key : Use the following command to generate a new SSH key pair: sh ssh-keygen -t rsa -b 4096 -C \"your_email@example.com\" Replace \"your_email@example.com\" with your email address. Save the Key : When prompted, press Enter to save the key in the default location ( ~/.ssh/id_rsa ) or specify a different location. Set a Passphrase : Optionally, enter a passphrase for added security. Add SSH Key to SSH Agent : Start the SSH agent and add your SSH private key: sh eval \"$(ssh-agent -s)\" ssh-add ~/.ssh/id_rsa Copy Public Key to Clipboard : Use the following command to copy your public key to the clipboard: sh pbcopy < ~/.ssh/id_rsa.pub If pbcopy is not available, you can manually copy the key from the ~/.ssh/id_rsa.pub file. Add Public Key to Server : Add your SSH public key to the ~/.ssh/authorized_keys file on the server you want to access.","title":"How to Create an SSH Key:"},{"location":"appendices/#theme","text":"The visual design and layout of an Omeka site. Themes determine how content is displayed to users and can be customized or developed to fit the branding of an organization.","title":"Theme"},{"location":"appendices/#user-role","text":"The permissions and access levels assigned to users within Omeka. Common roles include Administrator, Editor, and Viewer, each with different capabilities for managing content and settings.","title":"User Role"},{"location":"appendices/#quick-links","text":"For additional assistance, refer to the following resources: Omeka S Documentation : Access comprehensive user manuals and guides to help you navigate and make the most of Omeka S. Omeka Community Forums : Engage with the community, ask questions, and share knowledge about Omeka S. This is a great place to seek help from fellow users and experts. Project Documentation on Google Docs : As mentioned before, this sheet, from Yale University Library, is a goldmine of information. Please use. These resources provide valuable information and support to help you effectively use and troubleshoot Omeka S. Thanks for reading.","title":"Quick Links"},{"location":"configuration/","text":"IV. Configuration After installing Omeka S on your server, the next step is to configure it properly to ensure optimal performance and security. This segment covers the initial configuration steps, configuring plugins and themes, and customizing the appearance of your Omeka S site. Initial Configuration Database Configuration During the web-based installation process, you will be prompted to enter the database connection details. Ensure you have the following information ready: Database Name: omeka_s Database User: omeka_user Database Password: password Database Host: localhost Fill in these details in the appropriate fields and proceed with the installation. Admin User Setup You will also be prompted to create an admin user during the installation process. This user will have full access to all administrative functions in Omeka S. Username: Choose a unique username. Email: Enter a valid email address. Password: Create a strong password. Site Configuration Once the installation is complete, log in to the admin interface using the credentials created in the previous step. Navigate to Settings to configure the basic settings of your Omeka S site, such as site title, site description, and administrative contact information. Configuring Plugins Plugins extend the functionality of Omeka S. The following details the installation procedures for themes and modules. Installing Plugins Download the desired plugin from the Omeka S plugin directory. Extract the plugin archive and upload the plugin folder to the modules directory in your Omeka S installation path ( /var/www/html/omeka-s/modules ). Ensure correct file permissions: sh sudo chown -R www-data:www-data /var/www/html/omeka-s/modules/PluginName sudo chmod -R 755 /var/www/html/omeka-s/modules/PluginName Activating Plugins Log in to the Omeka S admin interface. Navigate to Modules . Find the newly installed plugin and click Install . Once installed, click Activate to enable the plugin. Configuring Plugin Settings After activation, many plugins will add their own configuration options to the admin interface. Navigate to the plugin\u2019s configuration page via Modules > [Plugin Name] and configure the settings as needed. Configuring Themes Themes control the appearance of your Omeka S site. Here\u2019s how to install and customize themes: Installing Themes Download the desired theme from the Omeka S themes directory. Extract the theme archive and upload the theme folder to the themes directory in your Omeka S installation path /var/www/html/omeka-s/themes . Ensure the correct file permissions: sh sudo chown -R www-data:www-data /var/www/html/omeka-s/themes/ThemeName sudo chmod -R 755 /var/www/html/omeka-s/themes/ThemeName Activating Themes Log in to the Omeka S admin interface. Navigate to Appearance . Find the newly installed theme and click Activate . Customizing Themes Each theme may have its own set of customization options, such as logo upload, color schemes, and layout settings. Navigate to Appearance > Themes > Configure to access and modify these settings. To make deeper customizations, you can directly edit the theme\u2019s files in the themes directory.","title":"Configuration"},{"location":"configuration/#iv-configuration","text":"After installing Omeka S on your server, the next step is to configure it properly to ensure optimal performance and security. This segment covers the initial configuration steps, configuring plugins and themes, and customizing the appearance of your Omeka S site.","title":"IV. Configuration"},{"location":"configuration/#initial-configuration","text":"","title":"Initial Configuration"},{"location":"configuration/#database-configuration","text":"During the web-based installation process, you will be prompted to enter the database connection details. Ensure you have the following information ready: Database Name: omeka_s Database User: omeka_user Database Password: password Database Host: localhost Fill in these details in the appropriate fields and proceed with the installation.","title":"Database Configuration"},{"location":"configuration/#admin-user-setup","text":"You will also be prompted to create an admin user during the installation process. This user will have full access to all administrative functions in Omeka S. Username: Choose a unique username. Email: Enter a valid email address. Password: Create a strong password.","title":"Admin User Setup"},{"location":"configuration/#site-configuration","text":"Once the installation is complete, log in to the admin interface using the credentials created in the previous step. Navigate to Settings to configure the basic settings of your Omeka S site, such as site title, site description, and administrative contact information.","title":"Site Configuration"},{"location":"configuration/#configuring-plugins","text":"Plugins extend the functionality of Omeka S. The following details the installation procedures for themes and modules.","title":"Configuring Plugins"},{"location":"configuration/#installing-plugins","text":"Download the desired plugin from the Omeka S plugin directory. Extract the plugin archive and upload the plugin folder to the modules directory in your Omeka S installation path ( /var/www/html/omeka-s/modules ). Ensure correct file permissions: sh sudo chown -R www-data:www-data /var/www/html/omeka-s/modules/PluginName sudo chmod -R 755 /var/www/html/omeka-s/modules/PluginName","title":"Installing Plugins"},{"location":"configuration/#activating-plugins","text":"Log in to the Omeka S admin interface. Navigate to Modules . Find the newly installed plugin and click Install . Once installed, click Activate to enable the plugin.","title":"Activating Plugins"},{"location":"configuration/#configuring-plugin-settings","text":"After activation, many plugins will add their own configuration options to the admin interface. Navigate to the plugin\u2019s configuration page via Modules > [Plugin Name] and configure the settings as needed.","title":"Configuring Plugin Settings"},{"location":"configuration/#configuring-themes","text":"Themes control the appearance of your Omeka S site. Here\u2019s how to install and customize themes:","title":"Configuring Themes"},{"location":"configuration/#installing-themes","text":"Download the desired theme from the Omeka S themes directory. Extract the theme archive and upload the theme folder to the themes directory in your Omeka S installation path /var/www/html/omeka-s/themes . Ensure the correct file permissions: sh sudo chown -R www-data:www-data /var/www/html/omeka-s/themes/ThemeName sudo chmod -R 755 /var/www/html/omeka-s/themes/ThemeName","title":"Installing Themes"},{"location":"configuration/#activating-themes","text":"Log in to the Omeka S admin interface. Navigate to Appearance . Find the newly installed theme and click Activate .","title":"Activating Themes"},{"location":"configuration/#customizing-themes","text":"Each theme may have its own set of customization options, such as logo upload, color schemes, and layout settings. Navigate to Appearance > Themes > Configure to access and modify these settings. To make deeper customizations, you can directly edit the theme\u2019s files in the themes directory.","title":"Customizing Themes"},{"location":"faq/","text":"Frequently Asked Questions (FAQ) Here are some commonly asked questions and their answers to help you better understand and navigate the Omeka S documentation and platform. What is Omeka S? Omeka S is a web publishing platform designed for sharing and displaying digital collections. It is particularly useful for libraries, archives, museums, and scholarly projects looking to manage and present digital resources. How do I access the admin dashboard? To access the admin dashboard, navigate to archives.kcsb.org/admin . Enter your username and password to log in. If you have forgotten your credentials, click on \"Forgot Password\" to reset them. How can I import items using CSV files? Omeka S allows batch importing of items through CSV files. Navigate to the \"CSV Import\" module in the admin dashboard, upload your CSV file, and map the columns to Omeka S metadata fields. For more detailed instructions, refer to the Creating and Managing Content section. How do I customize the theme of my site? You can customize the appearance of your Omeka S site by selecting and configuring themes. Go to the \"Themes\" section in the admin dashboard, choose a theme, and activate it. For further customization, you can modify theme files directly or create custom CSS. Where can I find additional resources and support? For more information, refer to the Omeka S Documentation and participate in discussions on the Omeka Community Forums . Contact Me If you have any further questions or need assistance, feel free to contact me using the form below. xs Contact Form If you have any questions or feedback, feel free to contact me using the form below. Your Name Your Email Your Message Send","title":"FAQ"},{"location":"faq/#frequently-asked-questions-faq","text":"Here are some commonly asked questions and their answers to help you better understand and navigate the Omeka S documentation and platform.","title":"Frequently Asked Questions (FAQ)"},{"location":"faq/#what-is-omeka-s","text":"Omeka S is a web publishing platform designed for sharing and displaying digital collections. It is particularly useful for libraries, archives, museums, and scholarly projects looking to manage and present digital resources.","title":"What is Omeka S?"},{"location":"faq/#how-do-i-access-the-admin-dashboard","text":"To access the admin dashboard, navigate to archives.kcsb.org/admin . Enter your username and password to log in. If you have forgotten your credentials, click on \"Forgot Password\" to reset them.","title":"How do I access the admin dashboard?"},{"location":"faq/#how-can-i-import-items-using-csv-files","text":"Omeka S allows batch importing of items through CSV files. Navigate to the \"CSV Import\" module in the admin dashboard, upload your CSV file, and map the columns to Omeka S metadata fields. For more detailed instructions, refer to the Creating and Managing Content section.","title":"How can I import items using CSV files?"},{"location":"faq/#how-do-i-customize-the-theme-of-my-site","text":"You can customize the appearance of your Omeka S site by selecting and configuring themes. Go to the \"Themes\" section in the admin dashboard, choose a theme, and activate it. For further customization, you can modify theme files directly or create custom CSS.","title":"How do I customize the theme of my site?"},{"location":"faq/#where-can-i-find-additional-resources-and-support","text":"For more information, refer to the Omeka S Documentation and participate in discussions on the Omeka Community Forums .","title":"Where can I find additional resources and support?"},{"location":"faq/#contact-me","text":"If you have any further questions or need assistance, feel free to contact me using the form below. xs","title":"Contact Me"},{"location":"faq/#contact-form","text":"If you have any questions or feedback, feel free to contact me using the form below. Your Name Your Email Your Message Send","title":"Contact Form"},{"location":"installation/","text":"Omeka S and LAMP Stack Dependencies Running Omeka S on a LAMP backend architecture involves several steps, including installing and configuring each component of the stack and then installing Omeka S itself. 1. Install Elementary OS Install Elementary OS from the official website and follow the installation instructions. 2. Install Apache Install Apache HTTP Server: sh sudo apt update sudo apt install apache2 Enable mod_rewrite : sh sudo a2enmod rewrite sudo systemctl restart apache2 Verification: Open a web browser and navigate to http://localhost . This will prompt the Apache2 default welcome page. 3. Configure Firewall Allow HTTP and HTTPS traffic through the firewall: sh sudo ufw allow in \"Apache Full\" 4. Install MySQL Install MySQL Server: sh sudo apt install mysql-server sudo mysql_secure_installation Secure MySQL Installation: sh sudo mysql -u root -p Create a database and a user for Omeka-S: sql CREATE DATABASE omeka_s; CREATE USER 'omeka_user'@'localhost' IDENTIFIED BY 'password'; GRANT ALL PRIVILEGES ON omeka_s.* TO 'omeka_user'@'localhost'; FLUSH PRIVILEGES; EXIT; Verification: Log into MySQL and check the databases: sh sudo mysql -u root -p SHOW DATABASES; Ensure the Omeka-S database is listed. 5. Install PHP and Required Extensions Install PHP and required extensions: sh sudo apt install php libapache2-mod-php php-mysql php-json php-mbstring php-xml php-dom php-simplexml php-fileinfo php-curl php-gd Verification: Create a PHP File to verify installation: sh echo \"\" | sudo tee /var/www/html/info.php Navigate to http://localhost/info.php , where the PHP information page will be visible. 6. Advanced PHP Configuration Adjust PHP settings for better performance: sh sudo nano /etc/php/7.4/apache2/php.ini This subsequent part is very important and something that I had trouble with. Don't forget to do this. Suggested adjustments: memory_limit = 256M upload_max_filesize = 64M post_max_size = 64M max_execution_time = 300 7. Install Composer and Git Install Composer and Git: sh sudo apt install composer sudo apt install git Version Control Verification: sh composer --version git --version 8. Install Omeka S Navigate to the web root and clone the Omeka S repository: sh cd /var/www/html sudo git clone https://github.com/omeka/omeka-s.git 9. Set File Permissions Set the correct file permissions: sh sudo chown -R www-data:www-data /var/www/html/omeka-s sudo chmod -R 755 /var/www/html/omeka-s 10. Install Omeka S Dependencies with Composer Install dependencies: sh cd omeka-s sudo composer install 11. Create a Host Config for Apache Create a new virtual host configuration: sudo nano /etc/apache2/sites-available/omeka-s.conf Add the following content to the config file: ServerAdmin webmaster@localhost DocumentRoot /var/www/html/omeka-s Options Indexes FollowSymLinks AllowOverride All Require all granted ErrorLog ${APACHE_LOG_DIR}/error.log CustomLog ${APACHE_LOG_DIR}/access.log combined 12. Enable the Virtual Host and Restart Apache Enable the virtual host and restart Apache: sh sudo a2ensite omeka-s.conf sudo systemctl restart apache2 13. Finalize Omeka S Installation Open a web browser and navigate to http://your-server-ip/omeka-s Follow the on-screen instructions to complete the Omeka S setup, entering the database information created earlier. 14. Enable HTTPS (Optional) Install Certbot for SSL/TLS configuration: sh sudo apt install certbot python3-certbot-apache sudo certbot --apache Follow Certbot's instructions to obtain and install a free SSL certificate from Let's Encrypt. 15. Optimize MySQL Configuration Consider optimizing MySQL for better performance: sh sudo nano /etc/mysql/mysql.conf.d/mysqld.cnf Add or modify configurations like: ini innodb_buffer_pool_size = 1G query_cache_size = 64M query_cache_type = 1 16. Enable Error Logging for Debugging Ensure error logging is enabled to assist with troubleshooting: apache php_flag display_errors Off php_flag log_errors On php_value error_log /var/www/html/omeka-s/php_errors.log 17. Set Up Cron Jobs for Maintenance (Optional) I didn't do this, but in retrospect would be better to complete Set up cron jobs for regular maintenance tasks: sh crontab -e Add tasks such as: cron 0 3 * * * php /var/www/html/omeka-s/application/data/scripts/backup.php 18. Security Considerations Secure MySQL: Ensure proper security practices are followed, such as securing the MySQL root account and using strong passwords. 19. Backup Procedures Document a simple backup procedure for Omeka S data: sh mysqldump -u omeka_user -p omeka_s > /path/to/backup/omeka_s_backup.sql By following these steps and meeting the system requirements, Omeka S will be effectively installed and configured on a LAMP stack, providing a robust platform for managing and sharing digital collections at 91.9 KCSB FM.","title":"Installation"},{"location":"installation/#omeka-s-and-lamp-stack-dependencies","text":"Running Omeka S on a LAMP backend architecture involves several steps, including installing and configuring each component of the stack and then installing Omeka S itself.","title":"Omeka S and LAMP Stack Dependencies"},{"location":"installation/#1-install-elementary-os","text":"Install Elementary OS from the official website and follow the installation instructions.","title":"1. Install Elementary OS"},{"location":"installation/#2-install-apache","text":"Install Apache HTTP Server: sh sudo apt update sudo apt install apache2 Enable mod_rewrite : sh sudo a2enmod rewrite sudo systemctl restart apache2 Verification: Open a web browser and navigate to http://localhost . This will prompt the Apache2 default welcome page.","title":"2. Install Apache"},{"location":"installation/#3-configure-firewall","text":"Allow HTTP and HTTPS traffic through the firewall: sh sudo ufw allow in \"Apache Full\"","title":"3. Configure Firewall"},{"location":"installation/#4-install-mysql","text":"Install MySQL Server: sh sudo apt install mysql-server sudo mysql_secure_installation Secure MySQL Installation: sh sudo mysql -u root -p Create a database and a user for Omeka-S: sql CREATE DATABASE omeka_s; CREATE USER 'omeka_user'@'localhost' IDENTIFIED BY 'password'; GRANT ALL PRIVILEGES ON omeka_s.* TO 'omeka_user'@'localhost'; FLUSH PRIVILEGES; EXIT; Verification: Log into MySQL and check the databases: sh sudo mysql -u root -p SHOW DATABASES; Ensure the Omeka-S database is listed.","title":"4. Install MySQL"},{"location":"installation/#5-install-php-and-required-extensions","text":"Install PHP and required extensions: sh sudo apt install php libapache2-mod-php php-mysql php-json php-mbstring php-xml php-dom php-simplexml php-fileinfo php-curl php-gd Verification: Create a PHP File to verify installation: sh echo \"\" | sudo tee /var/www/html/info.php Navigate to http://localhost/info.php , where the PHP information page will be visible.","title":"5. Install PHP and Required Extensions"},{"location":"installation/#6-advanced-php-configuration","text":"Adjust PHP settings for better performance: sh sudo nano /etc/php/7.4/apache2/php.ini This subsequent part is very important and something that I had trouble with. Don't forget to do this. Suggested adjustments: memory_limit = 256M upload_max_filesize = 64M post_max_size = 64M max_execution_time = 300","title":"6. Advanced PHP Configuration"},{"location":"installation/#7-install-composer-and-git","text":"Install Composer and Git: sh sudo apt install composer sudo apt install git Version Control Verification: sh composer --version git --version","title":"7. Install Composer and Git"},{"location":"installation/#8-install-omeka-s","text":"Navigate to the web root and clone the Omeka S repository: sh cd /var/www/html sudo git clone https://github.com/omeka/omeka-s.git","title":"8. Install Omeka S"},{"location":"installation/#9-set-file-permissions","text":"Set the correct file permissions: sh sudo chown -R www-data:www-data /var/www/html/omeka-s sudo chmod -R 755 /var/www/html/omeka-s","title":"9. Set File Permissions"},{"location":"installation/#10-install-omeka-s-dependencies-with-composer","text":"Install dependencies: sh cd omeka-s sudo composer install","title":"10. Install Omeka S Dependencies with Composer"},{"location":"installation/#11-create-a-host-config-for-apache","text":"Create a new virtual host configuration: sudo nano /etc/apache2/sites-available/omeka-s.conf Add the following content to the config file: ServerAdmin webmaster@localhost DocumentRoot /var/www/html/omeka-s Options Indexes FollowSymLinks AllowOverride All Require all granted ErrorLog ${APACHE_LOG_DIR}/error.log CustomLog ${APACHE_LOG_DIR}/access.log combined ","title":"11. Create a Host Config for Apache"},{"location":"installation/#12-enable-the-virtual-host-and-restart-apache","text":"Enable the virtual host and restart Apache: sh sudo a2ensite omeka-s.conf sudo systemctl restart apache2","title":"12. Enable the Virtual Host and Restart Apache"},{"location":"installation/#13-finalize-omeka-s-installation","text":"Open a web browser and navigate to http://your-server-ip/omeka-s Follow the on-screen instructions to complete the Omeka S setup, entering the database information created earlier.","title":"13. Finalize Omeka S Installation"},{"location":"installation/#14-enable-https-optional","text":"Install Certbot for SSL/TLS configuration: sh sudo apt install certbot python3-certbot-apache sudo certbot --apache Follow Certbot's instructions to obtain and install a free SSL certificate from Let's Encrypt.","title":"14. Enable HTTPS (Optional)"},{"location":"installation/#15-optimize-mysql-configuration","text":"Consider optimizing MySQL for better performance: sh sudo nano /etc/mysql/mysql.conf.d/mysqld.cnf Add or modify configurations like: ini innodb_buffer_pool_size = 1G query_cache_size = 64M query_cache_type = 1","title":"15. Optimize MySQL Configuration"},{"location":"installation/#16-enable-error-logging-for-debugging","text":"Ensure error logging is enabled to assist with troubleshooting: apache php_flag display_errors Off php_flag log_errors On php_value error_log /var/www/html/omeka-s/php_errors.log","title":"16. Enable Error Logging for Debugging"},{"location":"installation/#17-set-up-cron-jobs-for-maintenance-optional","text":"I didn't do this, but in retrospect would be better to complete Set up cron jobs for regular maintenance tasks: sh crontab -e Add tasks such as: cron 0 3 * * * php /var/www/html/omeka-s/application/data/scripts/backup.php","title":"17. Set Up Cron Jobs for Maintenance (Optional)"},{"location":"installation/#18-security-considerations","text":"Secure MySQL: Ensure proper security practices are followed, such as securing the MySQL root account and using strong passwords.","title":"18. Security Considerations"},{"location":"installation/#19-backup-procedures","text":"Document a simple backup procedure for Omeka S data: sh mysqldump -u omeka_user -p omeka_s > /path/to/backup/omeka_s_backup.sql By following these steps and meeting the system requirements, Omeka S will be effectively installed and configured on a LAMP stack, providing a robust platform for managing and sharing digital collections at 91.9 KCSB FM.","title":"19. Backup Procedures"},{"location":"introduction/","text":"Introduction The purpose of this documentation is to provide a comprehensive guide for using and managing the Omeka platform at 91.9 KCSB FM. Omeka is a web publishing platform ideal for sharing digital collections and creating media-rich online exhibits. This documentation covers everything from installation to advanced configuration and user management. It also delineates best practices for various website administrators, including the Archives Coordinator, Station Advisors, and Volunteers. The structure of this documentation is designed to facilitate ease of use, with sections dedicated to installation, configuration, user roles and permissions, content management, plugins and themes, backup and restore, maintenance and troubleshooting, and frequently asked questions (FAQ). Source Code The source code for this MkDocs website is available on GitHub. You can view, clone, or contribute to the project by visiting the repository below: GitHub Repository : KCSB_OMEKA_Documentation About the Project This documentation site is built using MkDocs with the Flatly theme. It includes customizations for Google Analytics integration and additional CSS for improved styling. Cloning the Repository To clone the repository and run the site locally, follow these steps: ```bash Clone the repository git clone https://github.com/lekhasapers/KCSB_OMEKA_Documentation.git Navigate into the project directory cd KCSB_OMEKA_Documentation Install dependencies pip install -r requirements.txt Serve the site locally mkdocs serve","title":"Introduction"},{"location":"introduction/#introduction","text":"The purpose of this documentation is to provide a comprehensive guide for using and managing the Omeka platform at 91.9 KCSB FM. Omeka is a web publishing platform ideal for sharing digital collections and creating media-rich online exhibits. This documentation covers everything from installation to advanced configuration and user management. It also delineates best practices for various website administrators, including the Archives Coordinator, Station Advisors, and Volunteers. The structure of this documentation is designed to facilitate ease of use, with sections dedicated to installation, configuration, user roles and permissions, content management, plugins and themes, backup and restore, maintenance and troubleshooting, and frequently asked questions (FAQ).","title":"Introduction"},{"location":"introduction/#source-code","text":"The source code for this MkDocs website is available on GitHub. You can view, clone, or contribute to the project by visiting the repository below: GitHub Repository : KCSB_OMEKA_Documentation","title":"Source Code"},{"location":"introduction/#about-the-project","text":"This documentation site is built using MkDocs with the Flatly theme. It includes customizations for Google Analytics integration and additional CSS for improved styling.","title":"About the Project"},{"location":"introduction/#cloning-the-repository","text":"To clone the repository and run the site locally, follow these steps: ```bash","title":"Cloning the Repository"},{"location":"introduction/#clone-the-repository","text":"git clone https://github.com/lekhasapers/KCSB_OMEKA_Documentation.git","title":"Clone the repository"},{"location":"introduction/#navigate-into-the-project-directory","text":"cd KCSB_OMEKA_Documentation","title":"Navigate into the project directory"},{"location":"introduction/#install-dependencies","text":"pip install -r requirements.txt","title":"Install dependencies"},{"location":"introduction/#serve-the-site-locally","text":"mkdocs serve","title":"Serve the site locally"},{"location":"maintenance/","text":"Maintenance and Troubleshooting Keeping the LAMP Stack Updated To ensure the LAMP stack remains secure and compatible with Omeka S, follow these steps to keep your system and software updated: Update Package Lists sudo apt update Upgrade Installed Packages sudo apt upgrade Full Distribution Upgrade sudo apt dist-upgrade Version Control Maintenance Ensure appropriate versions for Apache, MySQL, PHP: sudo apt install apache2 mysql-server php Check for specific version updates: Apache: sh apache2 -v MySQL: sh mysql --version PHP: sh php -v Configure Automatic Security Updates Install unattended-upgrades package: sudo apt install unattended-upgrades Enable automatic updates: sudo dpkg-reconfigure --priority=low unattended-upgrades By following these guidelines, KCSB\u2019s Omeka LAMP stack will remain up to date and secure, minimizing the risk of deprecation and ensuring continued compatibility with Omeka S. Backing Up Omeka S Overview Backing up Omeka S involves two main components: 1. Omeka S Files : This includes the application files, configuration files, themes, plugins, and uploaded files. 2. Database : Omeka S uses a database (typically MySQL) to store all metadata, settings, and relationships. Both components must be backed up regularly to ensure a complete and restorable backup. Prerequisites Access to the server where Omeka S is installed. Administrative privileges to access files and databases. Basic knowledge of command-line operations Step 1: Backing Up Omeka S Files Manual Backup Connect to Your Server : Use SSH to connect to your server. I've been using 'archives@128.111.126.136', but I'm not sure if you're on the same computer, so you may have to set that up on your own. sh ssh username@your-server-ip Navigate to the Omeka S Directory : Locate the directory where Omeka S is installed. sh cd /var/www/html/omeka-s Create a Compressed Archive : Use the tar command to create a compressed archive of the Omeka S directory. sh tar -czvf omeka-s-backup-$(date +%F).tar.gz . This command creates a tar.gz file named with the current date. Move the Backup File : Move the backup file to a safe location. sh mv omeka-s-backup-$(date +%F).tar.gz /path/to/backup/location Automated Backup (Using a Cron Job) Create a Backup Script : Create a shell script to automate the backup process. sh nano backup-omeka-s.sh Add the following content to the script: sh #!/bin/bash BACKUP_DIR=\"/path/to/backup/location\" OMEKA_DIR=\"/path/to/omeka-s\" TIMESTAMP=$(date +%F) tar -czvf $BACKUP_DIR/omeka-s-backup-$TIMESTAMP.tar.gz -C $OMEKA_DIR . Save and close the file. Make the Script Executable : sh chmod +x backup-omeka-s.sh Create a Cron Job : Open the crontab editor. sh crontab -e Add the following line to schedule the backup script to run daily at midnight: sh 0 0 * * * /path/to/backup-omeka-s.sh Step 2: Backing Up the Database Manual Backup Dump the Database : Use the mysqldump command to create a backup of the Omeka S database. sh mysqldump -u username -p omeka_database > omeka-db-backup-$(date +%F).sql Enter your MySQL password when prompted. Move the Backup File : Move the SQL file to a safe location. sh mv omeka-db-backup-$(date +%F).sql /path/to/backup/location Automated Backup (Using a Cron Job) Create a Database Backup Script : Create a shell script to automate the database backup process. sh nano backup-omeka-db.sh Add the following content to the script: sh #!/bin/bash BACKUP_DIR=\"/path/to/backup/location\" DB_USER=\"username\" DB_PASS=\"password\" DB_NAME=\"omeka_database\" TIMESTAMP=$(date +%F) mysqldump -u $DB_USER -p$DB_PASS $DB_NAME > $BACKUP_DIR/omeka-db-backup-$TIMESTAMP.sql Save and close the file. Make the Script Executable : sh chmod +x backup-omeka-db.sh Create a Cron Job : Open the crontab editor. sh crontab -e Add the following line to schedule the database backup script to run daily at 1 AM: sh 0 1 * * * /path/to/backup-omeka-db.sh Step 3: Verifying Backups List Backup Files : Check the backup location to ensure the files are created. sh ls /path/to/backup/location Test Restoration : Periodically test the restoration process to ensure backups are valid and complete. Regularly backing up your Omeka S installation is critical for data integrity and disaster recovery. By following the steps outlined in this documentation, you can ensure that both your files and database are safely backed up and can be restored if needed.","title":"Maintenance"},{"location":"maintenance/#maintenance-and-troubleshooting","text":"","title":"Maintenance and Troubleshooting"},{"location":"maintenance/#keeping-the-lamp-stack-updated","text":"To ensure the LAMP stack remains secure and compatible with Omeka S, follow these steps to keep your system and software updated:","title":"Keeping the LAMP Stack Updated"},{"location":"maintenance/#update-package-lists","text":"sudo apt update","title":"Update Package Lists"},{"location":"maintenance/#upgrade-installed-packages","text":"sudo apt upgrade","title":"Upgrade Installed Packages"},{"location":"maintenance/#full-distribution-upgrade","text":"sudo apt dist-upgrade","title":"Full Distribution Upgrade"},{"location":"maintenance/#version-control-maintenance","text":"Ensure appropriate versions for Apache, MySQL, PHP: sudo apt install apache2 mysql-server php Check for specific version updates: Apache: sh apache2 -v MySQL: sh mysql --version PHP: sh php -v","title":"Version Control Maintenance"},{"location":"maintenance/#configure-automatic-security-updates","text":"Install unattended-upgrades package: sudo apt install unattended-upgrades Enable automatic updates: sudo dpkg-reconfigure --priority=low unattended-upgrades By following these guidelines, KCSB\u2019s Omeka LAMP stack will remain up to date and secure, minimizing the risk of deprecation and ensuring continued compatibility with Omeka S.","title":"Configure Automatic Security Updates"},{"location":"maintenance/#backing-up-omeka-s","text":"","title":"Backing Up Omeka S"},{"location":"maintenance/#overview","text":"Backing up Omeka S involves two main components: 1. Omeka S Files : This includes the application files, configuration files, themes, plugins, and uploaded files. 2. Database : Omeka S uses a database (typically MySQL) to store all metadata, settings, and relationships. Both components must be backed up regularly to ensure a complete and restorable backup.","title":"Overview"},{"location":"maintenance/#prerequisites","text":"Access to the server where Omeka S is installed. Administrative privileges to access files and databases. Basic knowledge of command-line operations","title":"Prerequisites"},{"location":"maintenance/#step-1-backing-up-omeka-s-files","text":"","title":"Step 1: Backing Up Omeka S Files"},{"location":"maintenance/#manual-backup","text":"Connect to Your Server : Use SSH to connect to your server. I've been using 'archives@128.111.126.136', but I'm not sure if you're on the same computer, so you may have to set that up on your own. sh ssh username@your-server-ip Navigate to the Omeka S Directory : Locate the directory where Omeka S is installed. sh cd /var/www/html/omeka-s Create a Compressed Archive : Use the tar command to create a compressed archive of the Omeka S directory. sh tar -czvf omeka-s-backup-$(date +%F).tar.gz . This command creates a tar.gz file named with the current date. Move the Backup File : Move the backup file to a safe location. sh mv omeka-s-backup-$(date +%F).tar.gz /path/to/backup/location","title":"Manual Backup"},{"location":"maintenance/#automated-backup-using-a-cron-job","text":"Create a Backup Script : Create a shell script to automate the backup process. sh nano backup-omeka-s.sh Add the following content to the script: sh #!/bin/bash BACKUP_DIR=\"/path/to/backup/location\" OMEKA_DIR=\"/path/to/omeka-s\" TIMESTAMP=$(date +%F) tar -czvf $BACKUP_DIR/omeka-s-backup-$TIMESTAMP.tar.gz -C $OMEKA_DIR . Save and close the file. Make the Script Executable : sh chmod +x backup-omeka-s.sh Create a Cron Job : Open the crontab editor. sh crontab -e Add the following line to schedule the backup script to run daily at midnight: sh 0 0 * * * /path/to/backup-omeka-s.sh","title":"Automated Backup (Using a Cron Job)"},{"location":"maintenance/#step-2-backing-up-the-database","text":"","title":"Step 2: Backing Up the Database"},{"location":"maintenance/#manual-backup_1","text":"Dump the Database : Use the mysqldump command to create a backup of the Omeka S database. sh mysqldump -u username -p omeka_database > omeka-db-backup-$(date +%F).sql Enter your MySQL password when prompted. Move the Backup File : Move the SQL file to a safe location. sh mv omeka-db-backup-$(date +%F).sql /path/to/backup/location","title":"Manual Backup"},{"location":"maintenance/#automated-backup-using-a-cron-job_1","text":"Create a Database Backup Script : Create a shell script to automate the database backup process. sh nano backup-omeka-db.sh Add the following content to the script: sh #!/bin/bash BACKUP_DIR=\"/path/to/backup/location\" DB_USER=\"username\" DB_PASS=\"password\" DB_NAME=\"omeka_database\" TIMESTAMP=$(date +%F) mysqldump -u $DB_USER -p$DB_PASS $DB_NAME > $BACKUP_DIR/omeka-db-backup-$TIMESTAMP.sql Save and close the file. Make the Script Executable : sh chmod +x backup-omeka-db.sh Create a Cron Job : Open the crontab editor. sh crontab -e Add the following line to schedule the database backup script to run daily at 1 AM: sh 0 1 * * * /path/to/backup-omeka-db.sh","title":"Automated Backup (Using a Cron Job)"},{"location":"maintenance/#step-3-verifying-backups","text":"List Backup Files : Check the backup location to ensure the files are created. sh ls /path/to/backup/location Test Restoration : Periodically test the restoration process to ensure backups are valid and complete. Regularly backing up your Omeka S installation is critical for data integrity and disaster recovery. By following the steps outlined in this documentation, you can ensure that both your files and database are safely backed up and can be restored if needed.","title":"Step 3: Verifying Backups"},{"location":"system-requirements/","text":"System Requirements To ensure the Omeka S platform operates efficiently at 91.9 KCSB FM, it is essential to meet the following system requirements. These requirements cover both the server environment and required software dependencies. Server Requirements Operating System: - Elementary OS Hardware: Processor: Ideally 1 GHz or faster Memory: 2 GB RAM MINIMUM (4+ GB recommended) Storage: 20GB+ Disk Space Network: Reliable internet connection Software Dependencies Omeka S is run with a LAMP stack backend architecture. The software requirements are detailed below: Linux Elementary OS (Ubuntu): Ensure that your system is up-to-date to avoid security vulnerabilities and compatibility issues. Apache Apache HTTP Server 2.4 or higher Ensure mod_rewrite is enabled MySQL MySQL 5.7 or higher or MariaDB 10.1 or higher Recommended: InnoDB storage engine for tables to increase efficiency and provide foreign key support Must be configured to handle UTF-8 encoding: sql ALTER DATABASE your_database_name CHARACTER SET = utf8mb4 COLLATE = utf8mb4_unicode_ci; MySQL default collation/character set is generally utf8mb4 and utf8mb4_0900_ai_ci , but double-check to ensure. PHP PHP 7.4 or higher Required PHP extensions: PDO , pdo_mysql , mysqli , json , mbstring , xml , dom , simplexml , fileinfo , curl , gd Install required PHP extensions: sh sudo apt install php libapache2-mod-php php-mysql php-json php-mbstring php-xml php-dom php-simplexml php-fileinfo php-curl php-gd Additional Software Composer (for PHP dependencies) Git (for version control) SSL Certificate","title":"System Requirements"},{"location":"system-requirements/#system-requirements","text":"To ensure the Omeka S platform operates efficiently at 91.9 KCSB FM, it is essential to meet the following system requirements. These requirements cover both the server environment and required software dependencies.","title":"System Requirements"},{"location":"system-requirements/#server-requirements","text":"Operating System: - Elementary OS Hardware: Processor: Ideally 1 GHz or faster Memory: 2 GB RAM MINIMUM (4+ GB recommended) Storage: 20GB+ Disk Space Network: Reliable internet connection","title":"Server Requirements"},{"location":"system-requirements/#software-dependencies","text":"Omeka S is run with a LAMP stack backend architecture. The software requirements are detailed below:","title":"Software Dependencies"},{"location":"system-requirements/#linux","text":"Elementary OS (Ubuntu): Ensure that your system is up-to-date to avoid security vulnerabilities and compatibility issues.","title":"Linux"},{"location":"system-requirements/#apache","text":"Apache HTTP Server 2.4 or higher Ensure mod_rewrite is enabled","title":"Apache"},{"location":"system-requirements/#mysql","text":"MySQL 5.7 or higher or MariaDB 10.1 or higher Recommended: InnoDB storage engine for tables to increase efficiency and provide foreign key support Must be configured to handle UTF-8 encoding: sql ALTER DATABASE your_database_name CHARACTER SET = utf8mb4 COLLATE = utf8mb4_unicode_ci; MySQL default collation/character set is generally utf8mb4 and utf8mb4_0900_ai_ci , but double-check to ensure.","title":"MySQL"},{"location":"system-requirements/#php","text":"PHP 7.4 or higher Required PHP extensions: PDO , pdo_mysql , mysqli , json , mbstring , xml , dom , simplexml , fileinfo , curl , gd Install required PHP extensions: sh sudo apt install php libapache2-mod-php php-mysql php-json php-mbstring php-xml php-dom php-simplexml php-fileinfo php-curl php-gd","title":"PHP"},{"location":"system-requirements/#additional-software","text":"Composer (for PHP dependencies) Git (for version control) SSL Certificate","title":"Additional Software"},{"location":"user-guide/","text":"User Guide This section provides guidance on accessing and using the Omeka S website. Accessing the Website To access the Omeka S website, visit archives.kcsb.org . Accessing the Administrative Back-End The Omeka S administrative back-end is designed for managing collections, configuring settings, and overseeing the content displayed on your website. Here\u2019s how to access and navigate the admin dashboard: Visit the Admin Dashboard Go to archives.kcsb.org/admin . You will be prompted to log in with your administrative credentials. Login Credentials You will be prompted to log in with your administrative credentials. Enter your username and password to access the admin dashboard. If you have forgotten your password, use the \"Forgot Password\" link to reset it. Admin Dashboard Overview Once logged in, you will be taken to the main dashboard, which provides a quick overview of the site\u2019s activity and shortcuts to frequently used features. Navigation Menu The navigation menu on the left side of the dashboard allows you to access different sections: Items: Manage digital items in your collection, including adding, editing, and deleting items. Item Sets: Organize items into sets for better categorization and retrieval. Media: Upload and manage media files such as images, audio, and video associated with your items. Pages: Create and edit site pages to provide additional information and context for your collections. Users: Manage user accounts, assign roles, and set permissions. Modules: Add functionality to your Omeka S installation through various modules and plugins. Settings: Configure site-wide settings such as themes, languages, and API settings. User Roles and Permissions Omeka S supports multiple user roles, each with specific permissions: Global Administrator: Full access to all settings and content management features. This category will generally include the Engineer, Assistant Engineer, and the Archives Coordinator Supervisor: Manage content but with limited access to site-wide settings. This category will generally include the Advisors. Editor: Create and edit items and item sets but cannot change global settings. This category will generally include the experienced Archives volunteers Reviewer: Has content privileges but can only delete their own content. This category will generally include Archives volunteers. Author Can create their own content. This category will generally include beginner Archives volunteers. Researcher: Access public and private items for research purposes. This category will include the general public. Creating and Managing Content As indicated before, The content in Omeka S is organized into Items , Item Sets , and Media . This section explains how to create and manage these content types efficiently. There are also parameters to manage Users , which this section will review in depth. Adding Items Navigate to the \"Items\" Section: Access this section from the navigation menu on the left. Click \"Add New Item\": This opens the item creation form. Enter Item Details: Fill in fields such as title, description, and metadata. Attach Media Files: Upload associated files like images, audio, and video. Save the Item: Click \"Save\" to add the item to your collection. Adding a New Item Navigate to the \"Items\" section. Click \"Add New Item.\" Enter item details, such as title, description, and associated media. Save the item. Creating Item Sets Item Sets are groups of related items. They help organize collections. Go to \"Item Sets\": Access this section via the navigation menu. Click \"Add New Item Set\": This opens the item set creation form. Enter Set Details: Provide a title, description, and any relevant metadata. Add Items to the Set: Select items to include in the set. Save the Item Set: Click \"Save\" to create the item set. Managing Media Media management is critical for associating files with items. Upload Media Files: Access the \"Media\" section and click \"Add New Media.\" Select Files to Upload: Choose files from your computer or provide a URL for external media. Link Media to Items: Assign media to items, specifying their role (e.g., image, audio). Managing Users Access the \"Users\" section. Click \"Add New User\" to create a user account. Assign a role and set permissions for the user. Save the user account. CSV Upload A critical part of the KCSB content management workflow is the CSV upload module. Procedures and best practices will also be reviewed in this section. KCSB Spreadsheet Template: A template for preparing your CSV file is available to assist you. The KCSB Spreadsheet can be found here . Prepare Your CSV File: Format: Ensure your CSV file is formatted correctly, with column headers matching Omeka S metadata fields (e.g., title, description, creator). Include Media URLs: This has not been something I've been able to figure out, as there's a roadblock with linking URLs from Google Drive. However, if you find a way around it, please change my documentation so future archivists don't have to manually upload files. Navigate to CSV Import: Access the \"CSV Import\" module from the admin dashboard. Click \"Import CSV\" to begin the upload process. Upload the CSV File: Select File: Choose the CSV file from your computer. Configure Mapping: Map CSV columns to Omeka S fields. Ensure each column is correctly matched to a metadata field. Review and Confirm: Preview: Check the preview to ensure data is correctly mapped. Import: Click \"Import\" to add items to the collection. Monitor the import progress. Verify Import: Check Items: Ensure all items have been imported correctly. Review Media: Verify that media files are associated with the correct items. Modules and Extensions Omeka S allows for the integration of modules that extend the platform\u2019s functionality. Common modules include: CSV Import: Import items and metadata from CSV files. Search: Enhance search capabilities for users. Mapping: Display items on geographical maps. Contact Us Adds a contact form to front-end site Contact Us Module The Contact Us module adds a contact form to your site, allowing visitors to get in touch easily. For more information, refer to Omeka's technical documentation. This step has already been completed, but in the case that it needs to be reinstalled, please refer to the below instructions. Download and Install: Obtain the module from the Omeka S repository and install it via the admin dashboard. Configure Settings: Set up email addresses and form fields according to your needs. Add Contact Us Page: Navigate to Pages: Access the \"Pages\" section from the dashboard. Create New Page: Click \"Add New Page\" and select the Contact Us layout. Customize Form: Adjust form fields and settings as needed. Publish Page: Click \"Save\" to publish the Contact Us page. Verify: Test the form to ensure it functions correctly and that messages are received. As mentioned above, the KCSB module is already functioning, but feel free to remove and redownload using the above steps if anything ever goes wrong with module ops. Themes Themes control the visual appearance of your Omeka S site. They can be customized to align with your branding and design preferences. Changing Themes Navigate to \"Themes\": Access this section from the admin dashboard. Select a Theme: Choose from available themes or upload a custom theme. Activate Theme: Click \"Activate\" to apply the theme to your site. Backup and Security Regularly back up your database and files to prevent data loss. Implement security best practices, such as using strong passwords and updating software regularly. Getting Help For additional assistance, refer to the Omeka S Documentation or seek help from the community forums . A wonderful resource that was my personal Omeka bible was the Yale University Archives Study Guide . Use this resource frequently!","title":"User Guide"},{"location":"user-guide/#user-guide","text":"This section provides guidance on accessing and using the Omeka S website.","title":"User Guide"},{"location":"user-guide/#accessing-the-website","text":"To access the Omeka S website, visit archives.kcsb.org .","title":"Accessing the Website"},{"location":"user-guide/#accessing-the-administrative-back-end","text":"The Omeka S administrative back-end is designed for managing collections, configuring settings, and overseeing the content displayed on your website. Here\u2019s how to access and navigate the admin dashboard:","title":"Accessing the Administrative Back-End"},{"location":"user-guide/#visit-the-admin-dashboard","text":"Go to archives.kcsb.org/admin . You will be prompted to log in with your administrative credentials.","title":"Visit the Admin Dashboard"},{"location":"user-guide/#login-credentials","text":"You will be prompted to log in with your administrative credentials. Enter your username and password to access the admin dashboard. If you have forgotten your password, use the \"Forgot Password\" link to reset it.","title":"Login Credentials"},{"location":"user-guide/#admin-dashboard-overview","text":"Once logged in, you will be taken to the main dashboard, which provides a quick overview of the site\u2019s activity and shortcuts to frequently used features.","title":"Admin Dashboard Overview"},{"location":"user-guide/#navigation-menu","text":"The navigation menu on the left side of the dashboard allows you to access different sections: Items: Manage digital items in your collection, including adding, editing, and deleting items. Item Sets: Organize items into sets for better categorization and retrieval. Media: Upload and manage media files such as images, audio, and video associated with your items. Pages: Create and edit site pages to provide additional information and context for your collections. Users: Manage user accounts, assign roles, and set permissions. Modules: Add functionality to your Omeka S installation through various modules and plugins. Settings: Configure site-wide settings such as themes, languages, and API settings.","title":"Navigation Menu"},{"location":"user-guide/#user-roles-and-permissions","text":"Omeka S supports multiple user roles, each with specific permissions: Global Administrator: Full access to all settings and content management features. This category will generally include the Engineer, Assistant Engineer, and the Archives Coordinator Supervisor: Manage content but with limited access to site-wide settings. This category will generally include the Advisors. Editor: Create and edit items and item sets but cannot change global settings. This category will generally include the experienced Archives volunteers Reviewer: Has content privileges but can only delete their own content. This category will generally include Archives volunteers. Author Can create their own content. This category will generally include beginner Archives volunteers. Researcher: Access public and private items for research purposes. This category will include the general public.","title":"User Roles and Permissions"},{"location":"user-guide/#creating-and-managing-content","text":"As indicated before, The content in Omeka S is organized into Items , Item Sets , and Media . This section explains how to create and manage these content types efficiently. There are also parameters to manage Users , which this section will review in depth.","title":"Creating and Managing Content"},{"location":"user-guide/#adding-items","text":"Navigate to the \"Items\" Section: Access this section from the navigation menu on the left. Click \"Add New Item\": This opens the item creation form. Enter Item Details: Fill in fields such as title, description, and metadata. Attach Media Files: Upload associated files like images, audio, and video. Save the Item: Click \"Save\" to add the item to your collection.","title":"Adding Items"},{"location":"user-guide/#adding-a-new-item","text":"Navigate to the \"Items\" section. Click \"Add New Item.\" Enter item details, such as title, description, and associated media. Save the item.","title":"Adding a New Item"},{"location":"user-guide/#creating-item-sets","text":"Item Sets are groups of related items. They help organize collections. Go to \"Item Sets\": Access this section via the navigation menu. Click \"Add New Item Set\": This opens the item set creation form. Enter Set Details: Provide a title, description, and any relevant metadata. Add Items to the Set: Select items to include in the set. Save the Item Set: Click \"Save\" to create the item set.","title":"Creating Item Sets"},{"location":"user-guide/#managing-media","text":"Media management is critical for associating files with items. Upload Media Files: Access the \"Media\" section and click \"Add New Media.\" Select Files to Upload: Choose files from your computer or provide a URL for external media. Link Media to Items: Assign media to items, specifying their role (e.g., image, audio).","title":"Managing Media"},{"location":"user-guide/#managing-users","text":"Access the \"Users\" section. Click \"Add New User\" to create a user account. Assign a role and set permissions for the user. Save the user account.","title":"Managing Users"},{"location":"user-guide/#csv-upload","text":"A critical part of the KCSB content management workflow is the CSV upload module. Procedures and best practices will also be reviewed in this section.","title":"CSV Upload"},{"location":"user-guide/#kcsb-spreadsheet-template","text":"A template for preparing your CSV file is available to assist you. The KCSB Spreadsheet can be found here .","title":"KCSB Spreadsheet Template:"},{"location":"user-guide/#prepare-your-csv-file","text":"Format: Ensure your CSV file is formatted correctly, with column headers matching Omeka S metadata fields (e.g., title, description, creator). Include Media URLs: This has not been something I've been able to figure out, as there's a roadblock with linking URLs from Google Drive. However, if you find a way around it, please change my documentation so future archivists don't have to manually upload files.","title":"Prepare Your CSV File:"},{"location":"user-guide/#navigate-to-csv-import","text":"Access the \"CSV Import\" module from the admin dashboard. Click \"Import CSV\" to begin the upload process.","title":"Navigate to CSV Import:"},{"location":"user-guide/#upload-the-csv-file","text":"Select File: Choose the CSV file from your computer. Configure Mapping: Map CSV columns to Omeka S fields. Ensure each column is correctly matched to a metadata field.","title":"Upload the CSV File:"},{"location":"user-guide/#review-and-confirm","text":"Preview: Check the preview to ensure data is correctly mapped. Import: Click \"Import\" to add items to the collection. Monitor the import progress.","title":"Review and Confirm:"},{"location":"user-guide/#verify-import","text":"Check Items: Ensure all items have been imported correctly. Review Media: Verify that media files are associated with the correct items.","title":"Verify Import:"},{"location":"user-guide/#modules-and-extensions","text":"Omeka S allows for the integration of modules that extend the platform\u2019s functionality. Common modules include: CSV Import: Import items and metadata from CSV files. Search: Enhance search capabilities for users. Mapping: Display items on geographical maps. Contact Us Adds a contact form to front-end site","title":"Modules and Extensions"},{"location":"user-guide/#contact-us-module","text":"The Contact Us module adds a contact form to your site, allowing visitors to get in touch easily. For more information, refer to Omeka's technical documentation. This step has already been completed, but in the case that it needs to be reinstalled, please refer to the below instructions. Download and Install: Obtain the module from the Omeka S repository and install it via the admin dashboard. Configure Settings: Set up email addresses and form fields according to your needs.","title":"Contact Us Module"},{"location":"user-guide/#add-contact-us-page","text":"Navigate to Pages: Access the \"Pages\" section from the dashboard. Create New Page: Click \"Add New Page\" and select the Contact Us layout. Customize Form: Adjust form fields and settings as needed. Publish Page: Click \"Save\" to publish the Contact Us page. Verify: Test the form to ensure it functions correctly and that messages are received. As mentioned above, the KCSB module is already functioning, but feel free to remove and redownload using the above steps if anything ever goes wrong with module ops.","title":"Add Contact Us Page:"},{"location":"user-guide/#themes","text":"Themes control the visual appearance of your Omeka S site. They can be customized to align with your branding and design preferences.","title":"Themes"},{"location":"user-guide/#changing-themes","text":"Navigate to \"Themes\": Access this section from the admin dashboard. Select a Theme: Choose from available themes or upload a custom theme. Activate Theme: Click \"Activate\" to apply the theme to your site.","title":"Changing Themes"},{"location":"user-guide/#backup-and-security","text":"Regularly back up your database and files to prevent data loss. Implement security best practices, such as using strong passwords and updating software regularly.","title":"Backup and Security"},{"location":"user-guide/#getting-help","text":"For additional assistance, refer to the Omeka S Documentation or seek help from the community forums . A wonderful resource that was my personal Omeka bible was the Yale University Archives Study Guide . Use this resource frequently!","title":"Getting Help"}]} \ No newline at end of file