Updating: to 2.0.0

From Lorekeeper Wiki
Jump to navigation Jump to search

Version 2 of Lorekeeper brings several new features and improvements, including the integration of the previous modified-main branch and its extensions, the integration of Galleries, and the expansion of social media sites available for user authentication.

New in v2

Following are the major changes for this release. For a full list of changes, see <LINK TO RELEASE ON GITHUB HERE WHEN AVAILABLE>.

Update to Laravel 8

This update includes updating Laravel, the framework underlying Lorekeeper, to Laravel 8 (from 5.8). While the impact of this is relatively limited, it has some minor impacts in what methods are used for some tasks. This largely impacts extensions, which may need to be updated to account for these changes.

Extensions and Features from modified-main

modified-main was a branch incorporating several community-developed Extensions selected for their wide applicability and for falling into one of the following categories:

  • An unavoidable change in behavior, but one that is arguably a net quality-of-life improvement. May also be highly useful as a base for other extensions to build upon.
  • Opt-in/must be deliberately enabled for significant changes in the behavior of the site to occur. No more obtrusive than effectively optional functions in core Lorekeeper if not in use.

It includes certain extensions on an opt-in basis via a config file; these extensions tend to be sufficiently contained for this to be a viable option.

Also included are several minor but useful features:

  • Grouped Notifications: To account for the potentially large variety and potentially volume of notifications, they are grouped by notification type and collapse when there are more than 5 notifications of a type.
  • Toggleable Comments on Site Pages: Adds a toggle to site pages which enables/disables commenting on them. Disabled by default.
  • Extension Service: A utility for use by extension developers. By default, facilitates adjusting notification type IDs in a site's DB to comply with the Community Notification Standard. See the this command (made for Character Items) for an example of how to use this functionality.

This branch and its contents have been integrated into core as of this release, as they present strong improvements to the functionality of Lorekeeper.

Included Extensions

Documentation (where it exists) for these extensions can be viewed via Category: Extensions in modified-main.

Opt-In Extensions

Galleries

The Galleries extension has been integrated, providing Lorekeeper sites with the means to set up their own built-in galleries for user submissions of art and literature. See Galleries for more information.

Authentication Update

This update is in two parts. The first changes how aliases are stored, handled, and used around the site, while the second expands the range of social media platforms usable.

Changes to Alias Storage and Handling

  • Aliases-- users' usernames on social media platforms, used to authenticate them within Lorekeeper for purposes such as verifying character ownership, etc.-- are now stored in their own table within Lorekeeper's database rather than alongside the rest of the user's information. This allows Lorekeeper to support more than one alias per user.
    • Users now have a "primary" alias, which is always visible and is displayed on their profile, similar to the previous system.
    • Users may also have multiple non-primary aliases. These may or may not be visible to other users, as set by the user.
  • A config file has been added which handles sites both for authentication and formatting purposes.
  • Various systems using or searching by user aliases have been updated to use either on-site user or URL (previously was either on-site user and alias or alias only).
  • Systems which previously checked if an entered alias (such as for character ownership) belongs to an on-site user have been updated to do so with entered URLs.
    • Features that make use of this require a URL from a site enabled for auth in the associated config file. deviantArt is enabled by default.
  • Various features which display URLs now format them as "username@site" in the vein of the previous deviantArt alias link formatting.

Expansion of Authentication Options

Adds the ability to use additional social media platforms as authentication options (compared to the previous sole option of deviantArt).

  • Sites may be enabled for authentication in the associated config file; they may also be enabled for use as a user's primary alias separately in the same file.
  • Users may select the platform used for their initial link from the sites enabled both as an authentication and primary alias option.
  • Users may manage their linked aliases. This includes:
    • Changing primary alias
    • Hiding/unhiding non-primary aliases
    • Removing non-primary aliases
  • Users may link multiple accounts on the same social media platform
  • A page has been added to user profiles (accessible via the sidebar) listing the user's aliases

Credits Page

A credits page has been added. It provides a portion editable via the site pages admin panel for site-specific credits, lists extensions installed by way of integration into core (as above), and supplies a section for other extensions installed and tracked via an extension tracking system. This is supplied via a config file and command for updating the on-site tracker (php artisan update-extension-tracker).

Updating to v2

As of v2, Lorekeeper now requires PHP 7.4 (previously 7.2). No other requirements are changed.

Summary

  • Update your site or server to use PHP 7.4
  • Pull the updates, resolving any merge conflicts as appropriate
  • Make any config file changes
  • (Recommended) Put your site in maintenance mode via php artisan down
  • Push updates
  • Run composer update or equivalent and then php artisan update-lorekeeper-v2
  • (Recommended) Verify that no errors have occurred and use php artisan up to remove your site from maintenance mode
  • Perform any configuration desired within the site

Full Guide

Note that this guide assumes hosting on Dreamhost; guides for other hosts will be linked as created by community members. This guide also assumes a basic knowledge of git; see Tutorial: Introduction To Git if you need to review.

Updating your site to PHP 7.4

Note that this assumes your site is currently running PHP 7.2 as recommended for the previous version of Lorekeeper. If you are already running PHP 7.4, you can skip this step. To check, you may consult the Dreamhost control panel and enter into php -v PuTTY to check your PHP version.

  1. In the Dreamhost control panel, navigate to Domains > Manage Domains via the sidebar
  2. Click "Edit" for your site (under "Web Hosting")
  3. Under "Web Options", select one of the PHP 7.4 options for "PHP Mode"
  4. Click "Change settings". Allow 5-10 minutes or so for changes to process
  5. To verify changes, enter php -v into PuTTY

If after this php -v returns PHP 7.2 or others, follow these steps in PuTTY to update it (courtesy of this guide in the Lorekeeper Discord server):

  1. Enter cd ~ to ensure you are in your user directory
  2. Enter nano .bash_profile. This will open this file in the editor
  3. Add export PATH=/usr/local/php74/bin:$PATH to the end of the file
  4. Save the file by pressing ctrl+x, y, and then enter
  5. Enter . ~/.bash_profile to update the file you just saved
  6. Enter php -v again to verify that the update has worked

If this does not resolve the issue, contact support.

Pulling Updates

Pull updates from the Lorekeeper repo on GitHub. You may have renamed this remote to "origin-old" as part of the set up process.

  • Prior to v2's formal release, pull release/release-2.0.0.
  • Once v2 has released, pull master.

You may encounter merge conflicts as a result of this. Please see Tutorial: Installing Extensions - Merging Conflicts for information on how to resolve them. If you did not, or did and have resolved all extant conflicts, commit your changes (if you have not already).

You may wish to make changes to config files now, though you can do so later as well if desired (more information on added configuration options and settings is included later in this guide). If you wish to make changes now, it's recommended you review the following files and change settings as desired:

  • config/lorekeeper/settings
    • The pre-existing settings file. Additional options have been added in keeping with the addition of extensions from modified-main, etc.
  • config/lorekeeper/extensions
    • Added with the integration of modified-main. Allows toggling of opt-in extensions as outlined above, as well as handling some additional settings for them.
  • config/lorekeeper/sites
    • Controls which sites may be used for authentication as well as assisting with link formatting for other sites. Note that any site enabled for auth must also be configured on that platform. See Category: Social Media Authentication for instructions for supported sites. You may wish to prepare any additional sites you wish to use as an auth option before continuing with the update.

If/when you are ready, commit any changes to config files.

Pushing Updates

  1. Open PuTTY and navigate to your site's www directory (cd ~/site-name.com/www)
  2. Recommended: Before pushing any updates to your site, enter php artisan down in PuTTY to put your site in maintenance mode. This will prevent any users from making changes while updates are being run, which helps minimize the risk of issues occurring during the update process.
  3. Push the changes to your site
  4. Enter composer update (if you installed composer globally) or php composer.phar update (if you installed composer locally only)
    1. If you have not already done so, it's highly recommended you update composer itself to 2.x using composer self-update as it is a much faster and less resource-intensive version! You may be prompted to update using composer self-update --2 specifically; do so.
  5. Enter php artisan update-lorekeeper-v2. This will run a variety of commands to update Lorekeeper and any existing data in your site for v2.
    1. If you installed Extensions:Character Items prior to September 10th, 2020, also enter php artisan fix-char-item-notifs at this time
  6. If you put your site in maintenance mode earlier, enter php artisan up to put it back up
  7. Verify that no errors have occurred

Your site will now be updated and available to configure as desired.

Configuration

Configuration options and settings added as part of this update are listed here for convenience. For additional extension-specific configuration information, consult the extension's documentation.

Config Files

All following settings are configured via config files. For more information, see Config Files.

  • config/lorekeeper/settings.php
    • watermark_masterlist_images
      • Whether or not masterlist images are automatically watermarked.
      • Default: 0
    • masterlist_image_dimension
      • Dimension (in px) to scale the shorter dimension (between width/height) of masterlist images to. Set to 0 to disable resizing.
      • Default: 0
    • masterlist_image_format
      • Format to convert masterlist images to. Set to null to disable conversion.
      • Default: null
    • masterlist_image_background
      • Color (hex code) to fill the background of non-png image types when converting images to file formats that do not support transparency. Set to null to disable. Only takes effect when converting to a file format that isn't png.
      • Default: #ffffff
    • store_masterlist_fullsizes
      • Whether to store the full size of masterlist images (relevant if resizing and/or watermarking are enabled). Set to 0 to disable. Not retroactive either way.
      • Default: 0
    • masterlist_fullsizes_cap
      • Size (in px) to cap full-sized masterlist images at. Images above this cap in either dimension will be resized, retaining aspect ratio. Set to 0 to disable.
      • Default: 0
    • watermark_masterlist_thumbnails
      • Whether or not to watermark masterlist thumbnails. Expects the whole of the character to be visible, so it is recommended to use the thumbnail behavior/disable this if that isn't standard for your site. Set to 0 to disable.
      • Default: 0
    • masterlist_image_automation
      • When enabled, replaces the thumbnail cropper and automatically makes all masterlist images square, adding transparent space to the shorter dimension of the image to do so. Thumbnails are consequently resized versions of the full masterlist image.
      • Default: 0
    • default_purchase_limit
      • An arbitrary upper limit on the number of an item a user can purchase in a single shop transaction.
      • Default: 99
    • currency_symbol
      • Symbol for the (real world) currency used for sales posts.
      • Default: $
  • config/lorekeeper/extensions.php
    • navbar_news_notif
    • species_trait_index
    • character_status_badges
    • character_TH_profile_link
    • item_entry_expansion
      • Enables various features of Extensions:Item Entry Expansion
      • extra_fields
        • Enables extra fields.
        • Default: 0
      • resale_function
        • Enables the resale function.
        • Default: 0
      • loot_tables
        • enable
          • Adds the ability to use either rarity criteria for items or item categories with rarity criteria in loot tables. Note that disabling this does not apply retroactively.
          • Default: 0
        • alternate_filtering
          • By default this feature uses more broadly compatible methods to filter by rarity. If you are on Dreamhost/know your DB software can handle searching in JSON, it's recommended to set this to 1 instead.
          • Default: 0
    • traits_by_category
      • Enables grouping traits as listed on character pages by category.
      • Default: 0
    • character_reward_expansion
      • expanded
        • Enables expanded character rewards, allowing items and loot tables to be awarded to characters.
        • Default: 1
      • default_recipient
        • Recipient for items that cannot be held by characters. 0 to default to the character's owner (if a user), 1 to default to the submission user.
        • Default: 0
  • config/lorekeeper/sites.php
    • All sites have the following settings:
      • full_name
        • The full name of the site.
      • display_name
        • The shortened display name used, for instance, for link formatting.
      • regex
        • Regex pattern used to match URLs for the site.
      • link
        • The site's URL.
    • Sites which may be used for auth also have these settings:
      • icon
        • The Font Awesome icon used to represent the site within the Lorekeeper UI.
      • auth
        • Whether or not the site may be used for auth. At least one site must be enabled.
        • Default: 1 for deviantArt, 0 for others
      • primary_alias
        • Whether or not aliases from this site may be used as a user's primary alias. At least one site must be enabled.
        • Default: 1 for deviantArt, 0 for others
Site Settings

All following settings are configured in the Site Settings admin panel. For more information, see Site Settings.

  • admin_user
    • By default, this is used to direct notifications for comments on site pages to an account. Extensions may also use this setting. It's recommended that this correspond to the ID of an account that is not used by any one person and is solely for administrative purposes.
    • Default: 1
  • (Extensions:Design Update Voting) design_votes_needed
    • The number of votes needed for consensus on a design update.
    • Default: 3
  • (Extensions:Galleries) gallery_submissions_open
    • Whether or not gallery submissions are open globally.
    • Default: 1
  • (Extensions:Galleries) gallery_submissions_require_approval
    • Whether or not gallery submissions require approval.
    • Default: 1
  • (Extensions:Galleries) gallery_submissions_reward_currency
    • Whether or not gallery submissions reward currency.
    • Default: 0
  • (Extensions:Galleries) group_currency
    • ID of the group currency used for gallery submission rewards, if enabled.
    • Default: 1
  • (Reports) is_reports_open
    • Whether or not reports are open.
    • Default: 1
Site Pages

The content of the following pages is configured via the Pages admin panel. For more information, see Site Pages.

  • Credits
    • Part of/integrated into the larger credits page, which also displays extensions installed on the site. It is supplied via a site page for convenient editing, but does not need to/should not be displayed independently.