Jarm

Jarm provides an easy and simple way to share updates with family and friends in the form of photos, videos, and text updates.

Screenshots and a better introduction are available at thorlaksson.com/projects/jarm/.

Goals

• Private; intended for family and friends. Invite only.
• Easy setup and management.

Non-Goals

• Direct messages
• Federation
• Publically accessible

---

Server setup

Dependencies

Jarm depends on several external executables being available in your environment:

• ffmpeg via FFMPEG.
• ffprobe via FFMPEG.
• magick via ImageMagick.
• convert via ImageMagick.
• identify via ImageMagick.
• sqip via SQIP.
  • Jarm currently depends on the v1 alpha installed via npm install --global sqip-cli@canary.
  • SQIP is an npm packages and depends on Node >= v8.

Build a release

mix deps.get --only prod
MIX_ENV=prod mix compile
npm install --prefix ./assets
npm run deploy --prefix ./assets
MIX_ENV=prod mix phx.digest
MIX_ENV=prod mix release

Create an env file

This will be used by systemd to set up the environment.

To illustrate what this might look like let's assume you store your runtime files, like the database, in /opt/jarm/:

DATABASE_PATH="/opt/jarm/jarm.db"
URL="example.com"
ADMIN_EMAIL="[email protected]"
SMTP_USERNAME="[email protected]"
SMTP_PASSWORD="<email_password>"
SMTP_SERVER="smtp.example.com"
SMTP_PORT=465
SECRET_KEY_BASE="<secret_key>"
LIVE_VIEW_SIGNING_SALT="<secret_signing_salt>"

Migrate the database

# First, source your environment variables
source /opt/jarm/jarm_env
export $(cut -d= -f1 /opt/jarm/jarm_env )
jarm eval 'Jarm.Release.migrate()'

Start Jarm

Using the provided systemctl script from scripts/jarm.service:

systemctl start jarm

Running the release directly:

jarm start

This will run a bare HTTP server on port 4000. It's recommended that you run a reverse proxy via a webserver like Apache, Nginx, or Caddy in front of the application.

Send an invitation

jarm rpc 'Jarm.Release.send_invitation("<email>")'

or, if you already have an account set up, navigate to /users/invite on your site.

Grant administrator privileges to an account

jarm rpc 'Jarm.Release.grant_administrator_privileges_to("<email_for_existing_account>")'

Currently the CLI method is the only supported way to promote someone to an administrator.

---

Roadmap

V0.1

• SQLite
• Accounts
  • Send invitation via CLI
  • Reset password
  • Username, password, date created

V0.2

• Deployment
  • Move build-time configurations into runtime configurations
  • Build manifest for generating releases and build artifacts on Sourcehut
  • Automatic HTTPS via SiteEncrypt
  • Example systemd scripts

V0.3

• Posts
  • Username
  • Date
  • Message
  • Parent post (for comments — later)

V0.4

• Timeline
  • Display posts (username, date, message)
  • Pagination
• Edit post
• Delete post
• Only allow owner to edit and delete posts.
• User roles via canada; admin — moderator — user, or equivalent.

V0.5

• Photos in posts
  • Add photos to posts
• Videos in posts
  • Add videos to posts

V0.6

• Better styles via Tailwind CSS.
• Basic caching.
• Thumbnails for videos.
• Compression for photos (imagemagick converts to webp).
• Compression for videos (ffmpeg converts to mp4 w/ max bitrate of 2Mbps).
• Links to original videos and images provided.
• Phoenix updated to v1.6.
• Post page moved out of a live modal to its own page.

V0.7

• Photos
  • Edit photos in posts
  • Delete photos in posts
• Videos
  • Edit videos in posts
  • Delete videos in posts

V1 - micro-birdsite

• Single binary ready
• User profiles
  • Post overview
  • Media overview
  • Profile photos
• Documentation for server management, build, develop, etc.
• Blog posts

V2 - Admin UI and CLI

• Admin commands
  • Delete account by username, id, email
  • Send password reset
  • Set timezone — handled by the server instead of the software?
  • Delete specific photo by post
  • Delete specific video by post
  • Delete specific media by post

V3 - activity digest

• Comments on posts
• Daily/weekly digest email
  • Comments on your posts
  • Comments on posts you commented on
  • Summary of new posts
• Post version history
  • Store versions in database
  • Show “X revisions” label
  • Display revisions

V4 - optimizations

• Accept markdown via earmark and html_sanitize_ex and save as HTML in DB.
• Export photo data
• Lazy loading for images
• Lazy loading for videos
• Delete unused photos
• Delete unused videos

V5 - data export

• Create zip of all photos
• Create zip of photos from user
• Create zip of all videos
• Create zip of all media
• Create create zip of all videos by user
• Create zip of all media by user
• Export all data on user in CSV

V6 Third-party integrations

• Telegram integration?
• Instagram integration?
• Facebook integration?
• Matrix integration?

V7 - Accessibility

• Accessibility audit and fixes
  • alt text in <img> elements

V8 - For the admins

• Admin UI
  • Send invitation
  • Delete accounts
  • Delete comments
  • Delete posts
  • Change URL
  • Setup email credentials for server

V9 - translations

• Support translations for in-app strings
• Support custom translations for posts/comments
• Add Icelandic translations
• Add Filipino translations

V10 - timelines

• Timeline for “follow only” / Timeline for "non-muted"
• Timeline for everyone on instance
• Change new post notifications to have 2 sections; one per timeline

V11 - visibility

• Website for the project

V12 - read-only API

• GraphQL api for read only access

Future possibilities

• Mobile apps
  • iOS
  • Android
  • PWA?
• Desktop apps
  • Qt6/Tk
• Gemini support

V13 - mobile apps?

• iOS
• Android
• PWA?