HappyPanda X v0.11.1

Changelog

Notable fixes

• server: plugins would fail to load
• server: duplicate items would be added from watched folders
• docker: plugins were not being bundled
• docker: unicode errors from paths with non-ascii characters

Check out HappyPanda X Desktop

You can always refer to Settings in the docs for a description of all settings

Known issues in this build

• Regex searching does not work yet when the postgres dialect is used. A workaround is to disable regex when searching.

See here for possible known issues in this build

---

Read how to install and set up in the docs.

---

Changelog for 0.11.0

Highlights

• With this release it is now possible to logout 🎉
• A way to batch favorite, send to library and query for metadata has been added
• Managing users is now easier with the GUI
• Support for Docker has been added and a happypandax image is now available on the hub
• A tutorial for using HPX with Docker can be found in the docs
• The javascript client library js-client has now been published on NPM
• Things should now be a bit faster due to some light optimizations

---

New stuff

• webclient: added a logout button in the About modal
• webclient: added new page and view action buttons on the item viewer, enabling a way to manage the whole page or view of items
• webclient: support SessionExpiredError by automatically logging out
• webclient: added a new sidebar in the library page that will show on screens large enough to display gallery metadata instead of the modal
• webclient: added a new option in the page reader options to control smooth scrolling behaviour
• gui: added a way to mangage users and a slew of new useful buttons
• server: archives can now be extracted before sending it to an external viewer, enabled with the new setting gallery.send_extracted_archive
• server: improved thumbnail generation so that sizes will now be uniform. Added some new settings advanced.crop_wide_thumbnails and advanced.crop_thumbnail_alignment to alter this behavior.
• server: added new settings core.auto_pages_clean_size, advanced.image_sizes
• server/webclient: some speed improvements all around
• api: added new enum value ServerCommand.logout
• client api: added new api functions delete_items, update_metatags_for_view
• server: added support for specifying a directory where HPX should save its data with the environment variable HPX_DATA
• server: while not confirmed if working yet, support for the SOCKS protocol has been added
  • configure it like this:

  network:
      proxy:
          http:'socks5://user:pass@host:port'
          https='socks5://user:pass@host:port'
  

Changed stuff

• client api: added a new parameter item_ids to function update_metatags
• server: filters would fail to update when using postgres
• server: changed websocket path from /socket.io to /websocket
• server: changed the command-line arguments for user creation
• i18n: updated all en_us translations
• docs: updated docs

Notable fixes

• server: auto-updating would loop
• server: the auto-updater would fail to overwrite new files
• server: scan component tokens were not working
• server: proxy settings were not being applied
• webclient: plugin page urls would erroneously be absolute
• webclient: plugin pages would sometimes fail to redirect to the login page
• server: contents in archives were not being correctly read, causing some archives to get imported improperly
• server: attempting to delete a non-existing path would cause an error

HappyPanda X v0.11.0

Hello

Because the auto-updater was updated, it will only start working from next version on. Please install the update manually by replacing and overwriting the contents.

Highlights

• With this release it is now possible to logout 🎉
• A way to batch favorite, send to library and query for metadata has been added
• Managing users is now easier with the GUI
• Support for Docker has been added and a happypandax image is now available on the hub
• A tutorial for using HPX with Docker can be found in the docs
• The javascript client library js-client has now been published on NPM
• Things should now be a bit faster due to some light optimizations

---

Changelog

New stuff

• webclient: added a logout button in the About modal
• webclient: added new page and view action buttons on the item viewer, enabling a way to manage the whole page or view of items
• webclient: support SessionExpiredError by automatically logging out
• webclient: added a new sidebar in the library page that will show on screens large enough to display gallery metadata instead of the modal
• webclient: added a new option in the page reader options to control smooth scrolling behaviour
• gui: added a way to mangage users and a slew of new useful buttons
• server: archives can now be extracted before sending it to an external viewer, enabled with the new setting gallery.send_extracted_archive
• server: improved thumbnail generation so that sizes will now be uniform. Added some new settings advanced.crop_wide_thumbnails and advanced.crop_thumbnail_alignment to alter this behavior.
• server: added new settings core.auto_pages_clean_size, advanced.image_sizes
• server/webclient: some speed improvements all around
• api: added new enum value ServerCommand.logout
• client api: added new api functions delete_items, update_metatags_for_view
• server: added support for specifying a directory where HPX should save its data with the environment variable HPX_DATA
• server: while not confirmed if working yet, support for the SOCKS protocol has been added
  • configure it like this:

  network:
      proxy:
          http:'socks5://user:pass@host:port'
          https='socks5://user:pass@host:port'
  

Changed stuff

• client api: added a new parameter item_ids to function update_metatags
• server: filters would fail to update when using postgres
• server: changed websocket path from /socket.io to /websocket
• server: changed the command-line arguments for user creation
• i18n: updated all en_us translations
• docs: updated docs

Notable fixes

• server: auto-updating would loop
• server: the auto-updater would fail to overwrite new files
• server: scan component tokens were not working
• server: proxy settings were not being applied
• webclient: plugin page urls would erroneously be absolute
• webclient: plugin pages would sometimes fail to redirect to the login page
• server: contents in archives were not being correctly read, causing some archives to get imported improperly
• server: attempting to delete a non-existing path would cause an error

Check out HappyPanda X Desktop

You can always refer to Settings in the docs for a description of all settings

Known issues in this build

• Regex searching does not work yet when the postgres dialect is used. A workaround is to disable regex when searching.

See here for possible known issues in this build

---

Read how to install and set up in the docs.

HappyPanda X v0.10.2

Changelog

Notable fixes

• server: some database errors lingered when adding galleries from a scan
• server: the import.add_to_inbox didn't work as intended

You can always refer to Settings in the docs for a description of all settings

Known issues in this build

• The auto-updater will loop on fail. Please install the update manually, and delete files named internals in [HPX installation folder]/data.
• Regex searching does not work yet when the postgres dialect is used. A workaround is to disable regex when searching.

See here for possible known issues in this build

---

Read how to install and set up in the docs.

HappyPanda X v0.10.1

Hi :)

Highlights

• This minor release should make gallery scanning usable again.

---

Changelog

Changed stuff

• webclient: the scan page will now provide better feedback during scanning
• server: increased the default values for core.auto_temp_clean_size and core.auto_thumb_clean_size to 800

Notable fixes

• webclient: the filters page was not updated to reflect changes in the previous release
• webclient: the option to only scan for new galleries was inverted
• webclient: the option to set which folder to move galleries to was not working
• server: scanning for only new galleries would sometimes fail
• server: galleries that failed to be moved would still be added in all circumstances
• server: gallery pages would retain the old location when trying to move gallery
• server: where archive sources would sometimes not get deleted on gallery gallery deletion
• server: permissionerror's would always be raised when attempting to move gallery
• server: the auto backup would fail to initiate

You can always refer to Settings in the docs for a description of all settings

Known issues in this build

• The auto-updater will loop on fail. Please install the update manually, and delete files named internals in [HPX installation folder]/data.
• Regex searching does not work yet when the postgres dialect is used. A workaround is to disable regex when searching.

See here for possible known issues in this build

---

Read how to install and set up in the docs.

HappyPanda X v0.10.0

I'll be taking a break due to exams.

The auto-updater for this release hangs at "Starting HPX Updater". If this occurs, please manually install the update and overwrite your installation.

Highlights

• This release brings many changes across the board.
• The metadata fetcher has been revamped, it should now work more reliably and faster due to its new batching mechanism
• Auto-backup feature has been added. From this version onward, backups will be made automatically when updating through the application
• Folder watching, scan on startup, and moving of gallery files on import
• Filters now update automatically, (though with a bit of delay)
• Lots of plugin improvements including auto-updates and the ability for plugins to now have their own custom site
• This allows for several useful plugins to now be bundled with HPX
• I have created a python client library for HPX that should ease in creating HPX clients, see py-client. A js-client is coming as well
• Some of you probably miss a dedicated desktop application just like HappyPanda, for this I present HappyPanda X Desktop
• Lastly, lots of things have changed server-side which might break plugins and clients, see below for a detailed list of these changes

---

Changelog

New stuff

• webclient: added new item configuration and item log buttons to gallery page
• webclient: added new Tasks page
• webclient: read status will now be shown on galleries
• webclient: added new move settings add/gallery and add/scan pages
• webclient: added several new settings to Preferences
• server: added new metadata settings metadata.attributes, metadata.overwrites, metadata.continue_fetching, metadata.disabled, metadata.only_if_never_fetched
• server: added new settings regarding moving galleries and watching folders
• server: added new settings core.backup_on_update, core.auto_backup_interval, core.pg_dump_tool_path, core.pg_restore_tool_path
• server: added new commandline argument --backup to backup application
• server: added new commandline argument --restore to restore from backup
• server: implemented missing null search for several database item attributes. This means that searching "published date": null now works as it did in HappyPanda
• server: improved gallery filename parsing
• gui: added new button Backup and Restore to backup/restore application
• server: added Gallery.circles for cases like #91
• plugin: implemented auto-updating mechanism
  • it is possible to disable auto-updating for specific plugins by putting auto_update: false in their settings
• plugin: new hplugin.json attribute update_url
• client api: new api function get_properties to retrieve various properties about the server
• client api: new api functions get_plugin_config, set_plugin_config, add_item_log, get_item_log, update_plugin, check_plugin_update
• client api: new api function send_plugin_message, sweep_trash
• plugin api: add a trigger keyword argument to attach()
• plugin api: new plugin entry message
• plugin api: new plugin events before_update, after_update, config_update
• plugin api: new functions addfilter and removefilter to the interface module
• plugin api: new commands GetItemConfig, SetItemConfig, LogItem, UpdatePlugin, CheckPluginUpdate, AddCommandFilter, RemoveCommandFilter, BackupApplication, RestoreApplication
• plugin api: new ItemData commands to help modifying database items
• plugin api: new commands regarding watching folders
• server: upgraded the database to version 0.7.0

Changed stuff

• webclient: removed login and login info from Preferences. Please refer to the plugin's individual site instead. This can be accessed in About -> Plugins.

• client api: (breaking) the return values of set_config and save_config has been changed

• client api: (breaking) search options now require the fullname of settings, eg. namespace.setting

  • this concerns the api functions library_view, get_view_count, search_items

• server: ArtisName and ParodyName are now non-unique

• server: (breaking) removed the setting metadata.replace_metadata which is now superseeded by metadata.overwrites

• server: (breaking) renamed the setting namespace scan to import

• server: (breaking) moved several settings to the import namespace

  • gallery.add_to_inbox -> import.add_to_inbox
  • gallery.add_to_inbox -> import.add_to_inbox

• server: (breaking) renamed several settings

  • metadata.stop_after_one -> metadata.stop_after_first
  • metadata.first_candidate -> metadata.choose_first_candidate
  • search.match_whole_words -> search.match_exact
  • search.descendants -> search.children

• server: (breaking) Gallery.rating and Gallery.number are now float types

  • This can potentially break clients that receive a Gallery message object

• server: (breaking) GalleryFilter has been renamed to Filter

  • This can potentially break clients that receive a Filter message object

• plugin api: (breaking) rename command GetModelClass to GetDatabaseModel

• plugin api: (breaking) rename command NameParser to ItemTextParser

• client api: api functions restart_application and shutdown_application now return

• i18n: updated en_us.ui translation

• docs: updated docs

Fixes

• webclient: fixed auto remove setting in readlater drawer not working
• webclient: fixed a bug where the reader didn't switch to a new gallery properly #106
• server: fixed a bug where database items failed at getting deleted properly
• server: fixed a bug where gallery titles would be cut off at dots
• server: fixed a bug where the default super user would not be created on new databases #110
• server: fixed a bug where the built-in redis server would not be registered properly #103
• webclient: fixed misc. bugs all over

You can always refer to Settings in the docs for a description of all settings

Known issues in this build

• Regex searching does not work yet when the postgres dialect is used. A workaround is to disable regex when searching.

See here for possible known issues in this build

---

Read how to install and set up in the docs.

HappyPanda X v0.9.2

Next major version will be a breaking one (for plugins and clients)

Changelog

Fixes

• webclient: fixed an issue in the gallery reader where pages wouldn't fit the screen properly
• server: fixed an issue when trying to scan for galleries on a postgres backend
• server: fixed an issue where the server would hang when trying to edit a gallery on a postgres backend
• hptohpx: eh.. it should work now..

Known issues

• Regex searching does not work yet when the postgres dialect is used. A workaround is to disable regex when searching.

See here for possible known issues in this build

---

Read how to install and set up in the docs.

Changelog for 0.9.0

New stuff

• webclient: it is now possible to save a gallery for later reading
  • enabled Save for later tab in the drawer
• webclient: it is now possible to continue reading galleries from where left off
  • added related setting to Preferences/General
• webclient: added an end page in the gallery reader with suggestions on what to read next
• webclient: added a page count label on gallery items
• webclient: added Synchronise with source button on the page menu on gallery pages to allow re-syncing gallery pages with source on disk when editing a gallery
• webclient: several UI enchancements
• webclient: improved server call perfomance
• webclient: improved update process
• server: implemented server-side read progress tracking
• server: improved the gallery scanner to now be quicker when checking if a gallery already exists in the database
• server: added redis support
• server: added new settings gallery.pages_to_read, gallery.track_guest_read gallery.auto_remove_readlater
• server: added new settings server.use_builtin_redis, server.redis_host, server.redis_port and server.redis_password
• server: updated the database to version v0.6.0
• client api: function message objects now allows a special __id__ key that will be preserved in the responding message
• client api: added several new events
• client api: added new api function get_properties
• client api: added new api function get_last_read_page
• client api: added new api function sync_with_source
• plugin api: added new command SyncWithSource
• hpxtohp: added new cmdline argument --skip-filters to skip adding filters

Changed stuff

• webclient: the default login will now be as the default super user
• webclient: moved the Trash tab in about modal to a dedicated page
• webclient: removed Changelog tab from about
• client api: (deprecating) api function get_version is now deprecated and might be removed in a future version, use get_properties instead
• i18n: updated en_us.ui translation
• docs: updated docs

Fixes

• webclient: fixed a bug where tags would not show on galleries
• server: fixed a bug where it was not possible to log in
• webclient: fixed misc. bugs

HappyPanda X v0.9.1

Next major version will be a breaking one (for plugins and clients)

Changelog

Fixes

• server: it was not possible to start up HPX with a postgresql backend
• server: the console for redis server should now stay hidden
• hptohpx: it should work now

Known issues

• Regex searching does not work yet when the postgres dialect is used. A workaround is to disable regex when searching.

See here for possible known issues in this build

---

Read how to install and set up in the docs.

Changelog for 0.9.0

New stuff

• webclient: it is now possible to save a gallery for later reading
  • enabled Save for later tab in the drawer
• webclient: it is now possible to continue reading galleries from where left off
  • added related setting to Preferences/General
• webclient: added an end page in the gallery reader with suggestions on what to read next
• webclient: added a page count label on gallery items
• webclient: added Synchronise with source button on the page menu on gallery pages to allow re-syncing gallery pages with source on disk when editing a gallery
• webclient: several UI enchancements
• webclient: improved server call perfomance
• webclient: improved update process
• server: implemented server-side read progress tracking
• server: improved the gallery scanner to now be quicker when checking if a gallery already exists in the database
• server: added redis support
• server: added new settings gallery.pages_to_read, gallery.track_guest_read gallery.auto_remove_readlater
• server: added new settings server.use_builtin_redis, server.redis_host, server.redis_port and server.redis_password
• server: updated the database to version v0.6.0
• client api: function message objects now allows a special __id__ key that will be preserved in the responding message
• client api: added several new events
• client api: added new api function get_properties
• client api: added new api function get_last_read_page
• client api: added new api function sync_with_source
• plugin api: added new command SyncWithSource
• hpxtohp: added new cmdline argument --skip-filters to skip adding filters

Changed stuff

• webclient: the default login will now be as the default super user
• webclient: moved the Trash tab in about modal to a dedicated page
• webclient: removed Changelog tab from about
• client api: (deprecating) api function get_version is now deprecated and might be removed in a future version, use get_properties instead
• i18n: updated en_us.ui translation
• docs: updated docs

Fixes

• webclient: fixed a bug where tags would not show on galleries
• server: fixed a bug where it was not possible to log in
• webclient: fixed misc. bugs

HappyPanda X v0.9.0

Next major version will be a breaking one (for plugins and clients)

Changelog

New stuff

• webclient: it is now possible to save a gallery for later reading
  • enabled Save for later tab in the drawer
• webclient: it is now possible to continue reading galleries from where left off
  • added related setting to Preferences/General
• webclient: added an end page in the gallery reader with suggestions on what to read next
• webclient: added a page count label on gallery items
• webclient: added Synchronise with source button on the page menu on gallery pages to allow re-syncing gallery pages with source on disk when editing a gallery
• webclient: several UI enchancements
• webclient: improved server call perfomance
• webclient: improved update process
• server: implemented server-side read progress tracking
• server: improved the gallery scanner to now be quicker when checking if a gallery already exists in the database
• server: added redis support
• server: added new settings gallery.pages_to_read, gallery.track_guest_read gallery.auto_remove_readlater
• server: added new settings server.use_builtin_redis, server.redis_host, server.redis_port and server.redis_password
• server: updated the database to version v0.6.0
• client api: function message objects now allows a special __id__ key that will be preserved in the responding message
• client api: added several new events
• client api: added new api function get_properties
• client api: added new api function get_last_read_page
• client api: added new api function sync_with_source
• plugin api: added new command SyncWithSource
• hpxtohp: added new cmdline argument --skip-filters to skip adding filters

Changed stuff

• webclient: the default login will now be as the default super user
• webclient: moved the Trash tab in about modal to a dedicated page
• webclient: removed Changelog tab from about
• client api: (deprecating) api function get_version is now deprecated and might be removed in a future version, use get_properties instead
• i18n: updated en_us.ui translation
• docs: updated docs

Fixes

• webclient: fixed a bug where tags would not show on galleries
• server: fixed a bug where it was not possible to log in
• webclient: fixed misc. bugs

Known issues

• Regex searching does not work yet when the postgres dialect is used. A workaround is to disable regex when searching.

See here for possible known issues in this build

---

Read how to install and set up in the docs.

HappyPanda X v0.8.1

Changelog

New stuff

• webclient: improved image loading

Fixes

• webclient: fixed gallery page blanking out in certain circumstances

Known issues

• Regex searching does not work yet when the postgres dialect is used. A workaround is to disable regex when searching.

See here for possible known issues in this build

---

Read how to install and set up in the docs.

Changelog for 0.8.0

New stuff

• webclient: gallery filters are now working! 🎉🎉
  • but.. due to time constraints I was not able to finish implementing filters automatically updating, so for now they have to be updated manually on the filter page
  • also... be aware that regex searching still does not work yet when using a postgres backend
• webclient: improved editing! editing items should now be way less painful
• webclient: new page for filters in management
• webclient: the reader will now display parent tags and page tags
• webclient: gallery pages will now display a thumbnail when creating a new gallery
• webclient: the scan page will now display errors
• server: updated the database to version v0.5.0
• server: added new sort indexes CircleName and FilterName
• server: improved perfomance due to rudimentary caching and simple database optimizations
• server: added new setting core.cache_expiration_time
• server: improved exception error messages
• client api: added support for GalleryFilter in search_items api function
• client api: added new api function update_filters
• client api: added new api function get_image_from_path
• plugin api: added new command UpdateFilters

Changed stuff

• plugin api: (breaking) rename ImageItem command to GetImage
• client api: (breaking) get_command_state, start_command and stop_command api functions will now return a CommandState enum by its value instead of name
• i18n: updated en_us.ui and en_us.general translations
• docs: updated docs

Fixes

• server: improved unique item coercion from message objects
• webclient: fixed favorite button not working on the collection page
• webclient: fixed lots of misc. bugs

HappyPanda X v0.8.0

It's been a while

Changelog

New stuff

• webclient: gallery filters are now working! 🎉🎉
  • but.. due to time constraints I was not able to finish implementing filters automatically updating, so for now they have to be updated manually on the filter page
  • also... be aware that regex searching still does not work yet when using a postgres backend
• webclient: improved editing! editing items should now be way less painful
• webclient: new page for filters in management
• webclient: the reader will now display parent tags and page tags
• webclient: gallery pages will now display a thumbnail when creating a new gallery
• webclient: the scan page will now display errors
• server: updated the database to version v0.5.0
• server: added new sort indexes CircleName and FilterName
• server: improved perfomance due to rudimentary caching and simple database optimizations
• server: added new setting core.cache_expiration_time
• server: improved exception error messages
• client api: added support for GalleryFilter in search_items api function
• client api: added new api function update_filters
• client api: added new api function get_image_from_path
• plugin api: added new command UpdateFilters

Changed stuff

• plugin api: (breaking) rename ImageItem command to GetImage
• client api: (breaking) get_command_state, start_command and stop_command api functions will now return a CommandState enum by its value instead of name
• i18n: updated en_us.ui and en_us.general translations
• docs: updated docs

Fixes

• server: improved unique item coercion from message objects
• webclient: fixed favorite button not working on the collection page
• webclient: fixed lots of misc. bugs

Known issues

• Regex searching does not work yet when the postgres dialect is used. A workaround is to disable regex when searching.

See here for possible known issues in this build

---

Read how to install and set up in the docs.