🦝 Lockpick

Open source migroblogging platform powered by raccoons

Lockpick is maybe acceptable for use. I can't reccomend it, but I run it in production personally.

✨ Features

• ActivityPub support
  Lockpick will communicate with other softwares that implement ActivityPub like Misskey, Mastodon, and Akkoma.
• Customizable Web UI
  Lockpick adds additional client settings that you can use to make your UI as you'd like it.
• Increased Mobile Support
  Lockpick's UI is more mobile friendly and adjusts to your screen size

🏠 Instances

Last updated 2024-01-30. To have your instance listed here, make an issue with the instance list tag.

• https://eepy.zone/ - 40 users
  A small and eepy public instance for silly creatures. For more information see https://eepy.zone/@blueb/pages/info.

🖥️ Fresh Installation

Before starting, make sure you have all of the following:

• a machine that is connected to the internet (best on Linux)
• a domain or subdomain for the instance
• a web server running on the machine

I reccomend the PM2 method, but you can also use Docker. If you run into problems with Docker, I may not be able to help as much.

With PM2 (reccomended)

Dependencies

• NodeJS v20.4 or later
• PostgreSQL v15 or later
• Redis
• FFmpeg
• build-essential or equivalent
• Python

Prepare environment

Clone the repository, install Node packages, and copy the default config.

git clone --recurse-submodules -b develop https://git.gay/blueb/Lockpick.git
cd Lockpick
pnpm install --frozen-lockfile
cp .config/example.yml .config/default.yml

Configuration

Before starting, make sure you configure Lockpick. Comments in the file will help you out, but only the following need to be changed accordingly:

url: https://{DOMAIN}/
db:
  host: localhost
  port: 5432
  db: lockpick
  user: lockpick
  pass: {DATABASE_USER_PASSWORD}

Database Setup

To run Lockpick, you need to be able to access a database. Login as the PostgreSQL user and create a user.

sudo su - postgres
psql

Then, run the neccesary SQL queries and exit afterwards.

CREATE DATABASE lockpick WITH ENCODING = 'UTF8';
CREATE USER lockpick WITH ENCRYPTED PASSWORD '{DATABASE_USER_PASSWORD}';
GRANT ALL PRIVILEGES ON DATABASE lockpick TO lockpick;
ALTER DATABASE lockpick OWNER TO lockpick;
\q

Final Steps

After the database is setup, you're almost good to go! All you have left is to build Lockpick, create the schema, and start the instance.

pnpm build
pnpm run init
pnpm start

Now that you've tested if it can run, you can kill the process (CTRL+C will do it) and set it up for production. Next, install PM2.

npm i -g pm2
pm2 install pm2-logrotate

Then, you can start your instance in production mode.

pm2 start "NODE_ENV=production pnpm run start" --name Lockpick

🖥️ Updating

Updating Lockpick is simple and only takes a few commands. In your Lockpick directory as the Lockpick user run the following:

git pull
pnpm install --frozen-lockfile
pnpm run build
pnpm run migrate

...and then restart your instance. You're good to go!

ℹ️ Troubleshooting

I can't find out how to do something and it isn't listed here

Try checking out the official Misskey docs, some things are listed there that aren't here but work the same. https://misskey-hub.net/en/docs/

When I try updating, the build fails

Try running pnpm run clean and rerunning the update commands. Otherwise, you should make an issue.

📜 Changelog

This project does not use CHANGELOG.md, and instead lists all changes chronologically here. Most recent changes at the top.

2024.4.0.dev1

• Added a drafts page to manage drafts locally saved in the user's browser localstorage.
• Fix renotes not appearing in drafts properly

2024.3.1.dev4

• Reports in admin panel redesigned
  • Clearer language, instead of saying "Moderator: user" it says "Resolved by user"
  • Made resolved reports differently styled, they're more transparent until hovered.
  • Better for smaller screens (and most, looked weird on most), user reported now at top instead of on the left.
  • Moved a few elements around
  • Added consistent spacing

2024.3.1.dev1, 2024.3.1.dev2, 2024.3.1.dev3, and versions since 2024.1.0.dev5

• Various merges from upstream Sharkey
• Refer to boosts as repeats
• Respect user preference of note style in more locations
• "Repeated by {}" is now "{} repeated"
• Add a smalled max width for instance ticker
• Added themes
  • Catppuccin Mocha, Frappe, and Latte (all accent colors)
  • Iceshrimp
  • Rose Pine
• Change UI for likes to be stars, make default a star
• Change handling of likes
• Fix stupid things I did to migrations
• Add $[center ] and $[small ] MFM
• Change "Pinned users" section to use push pin icon
• Fix icons for sub/pub icons in federation tab of dashboard to be different instead of both being just planets
• Adjust more locale strings to use the word "content warning" over "hidden content"
• Change content warning from eye-slash to warning
• Change last two random strings that are placeholders in the post form

2024.1.0.dev5, 2024.1.0.dev6

• Make classic timeline sidebar items pop out on hover
• Fix wrapping of mentions (origin)
• Fix local instance ticker bug that stopped notes from rendering (origin)
• Refactored shortened notes being replied to in timeline and notifications (origin)
• Add toggle for icon on notes next to the time it was posted that indicates if a post is a reply
• Add cat friend (origin)

2024.1.0.dev3, 2024.1.0.dev4

• Fix long usernames linebreaking in short subnotes causing it to look awkward
• Modify styling of Calendar widget to emphasize current day
• Update English translations (see commit history for en-US.yml, mostly Reversi related)
• Added fonts to the font picker
  • Almarai
  • Cabin
  • Geologica
  • IBM Plex Sans
  • Merriweather Sans
  • Montserrat
  • Nunito
  • Nunito Sans
  • Plus Jakarta Sans
  • Poppins
  • Public Sans
  • Raleway
  • Red Hat Display
  • Rethink Sans
  • Rubik
  • Space Grotesk
  • Space Mono
  • Urbanist
  • Work Sans
• Replace icons
  • ph-smiley -> ph-plus for reaction buttons
• Add circle corner roundness
• Show alt text on hover of video (origin)
• Use dropdown for font picker instead of radios
• Update translations for shortened subnotes setting (origin)
• Smaller avatars under detailed note (origin)
• Add slim bottom bar for mobile with deck layout
• Fix edits not allowing one poll option
• Allow maximum of 25 poll options
• Allow scrolling within post form
• Adjust alignment and margin of icon in detailed note tabs
• Only display the most recent pure renote (origin, origin)
• Add option to only show icon on instance ticker (origin)
• Automatically grow textarea (origin)
• Have robots.txt automatically deny usage to the following: (origin)
  • CCBot
  • ChatGPT-User
  • GPTBot
  • Google-Extended
  • Omgilibot
  • FacebookBot
  • Amazonbot
• Add English (Cat Mode) as a language

2024.1.0.pre1 (Pre-Release 1)

First Lockpick prerelease will include 2024.1.0.dev1 & 2024.1.0.dev2

2024.1.0.dev2

• Pull upstream Sharkey changes (see #4)
• Remove donation modal.
• Rename "Favorites" to "Bookmarks", other fedi software does not refer to this feature as favorites.
• Rename "Comments" to "Content Warning"
• Redesign the content warning field, it's taller on mobile and uses warning colors.
• Fix inconsistant defederation visibility tooltips
• Make widget sidebar opening button aligned to the center of the button.
• Changed icons
  • Replaced ph-squares-four for widget sidebar with ph-stack
• Use SkNote in bookmarks
• Added v-tooltip for absolute time on notes
• More aggressive no alt text indicator with warning background, text color, and warning icon

2024.1.0.dev1

• Changed icons
  • ph-pencil -> ph-pencil-simple
  • For boosts, ph-rocket-launch -> ph-repeat
  • For bubble timeline, ph-drop/ph-thumb-up -> ph-circles-three
  • For global timeline, ph-globe-hemisphere-west -> ph-planet
  • For local timeline, ph-planet -> ph-map-pin
  • ph-power -> ph-sign-out
  • ph-dots-nine -> ph-dots-three
• Use v-tooltip more over title
• Some hardcoded colors removed
  • #ff2a2a -> var(--error)
• Margin changes
  • Increased margin between renote icon and renote text
• Additional themes included
  • Purpura (default dark)
  • Wisteria
• Stop using launcher.moe links
• Add font picker
  • Option to use a font specified in theme files, otherwise falls back to Figtree
  • Option to use system-ui font
  • Add AtkinsonHyperlegible font
  • Add Commissioner font
  • Add DMSans font
  • Add Figtree font (default)
  • Add FiraSans font
  • Add Inter font
  • Add JetBrainsMono font
  • Add Lato font
  • Add Lexend font
  • Add NotoSans font
  • Add OpenDyslexic font
  • Add OpenSans font
  • Add Roboto font
  • Add SourceSans3 font
  • Add Ubuntu font
• Remove annoying post warning
• Allow polls with one option
• Right align field names
• Changed default settings
  • Timeline note gaps enabled by default
  • Renotes collapsed by default
  • Emoji picker scale is big
  • Emoji picker width is 8 columns
  • Emoji picker height is big
  • Reaction display size is small
  • Blur effects enabled
• Mobile bottom bar shorter
• Instance ticker opens instance information page on click
• Hovering over instance ticker shows software name and version
• Remove channel picker icon from main timeline page
• Make footer wider on smaller screens
• Add icon to indicate if a post is a reply
• Rounded corner radius by default
• Put profile stat count and label on same line
• Remove AiChan