97 lines
4.7 KiB
Markdown
97 lines
4.7 KiB
Markdown
# Moshing Mammut
|
|
|
|
The fine folks on the [metalhead.club Mastodon Server](https://metalhead.club) occasionally share like to share
|
|
what they're currently listening to.
|
|
Having a quick overview over what is being posted can be a great way to discover new music!
|
|
|
|
# Technical Notes
|
|
|
|
This is fairly simple from a technical point of view! metalhead.club's local timeline is being watched using the
|
|
Mastodon Streaming API over a Websocket. Every time a new post arrives, it is checked if it contains any music by
|
|
checking included hashtags and URLs. A list of tags and URLs can be found in [the configuration](.env.EXAMPLE).
|
|
Additionally, lins to YouTube are queried, if they are music or other videos using the YouTube API.
|
|
|
|
If a post passes this check it is saved to a SQLite database.
|
|
|
|
The UI is built using [SvelteKit](https://kit.svelte.dev). The initial page is rendered on the server, and works even
|
|
without Javascript. If Javascript is enabled, new posts are fetched every 10 seconds, but there are plans to switch
|
|
to Websockets instead. See #10.
|
|
|
|
# The ~~Mastodon~~ Elephant in the Room
|
|
|
|
> So, are you just going to save other peoples posts into your own database?
|
|
|
|
I'm afraid so, and I'm not particularly happy about this. I've thought about how to do it without and it doesn't look
|
|
good.
|
|
|
|
My initial plan was to search for posts and work with the search results, however
|
|
Mastodon doesn't offer full text search, so this would be limited to work with hashtags.
|
|
I can see that there are plenty of posts using only descriptions and links without a corresponding hashtag that would
|
|
be missed. This isn't a great solution.
|
|
|
|
Another idea was to store only URLs of posts and resolve the content and account information live.
|
|
This would be better, but I'm *still* storing post information while also slowing the app down and introduce more code
|
|
complexity. I'm willing to make this change if people prefer this though.
|
|
|
|
Additionally, I ended up adding a few things which turned out to be not needed:
|
|
The `tags` table (tags are included in the post's content and I don't do anything separately with tags) and
|
|
`accounts.username` and `accounts.avatar_static`. I will keep these in until the initial wave of feedback arrives, and
|
|
remove it if no new features required them.
|
|
|
|
I'll gladly accept any help in coming up with a good solution which doesn't need to store anything at all!
|
|
|
|
# Set Up
|
|
|
|
This might not be the ideal setup to run this, but here's how I am doing it. Instructions are for running on a Debian
|
|
or Debian derivative, using Apache as HTTP Proxy. Other setups are possible, but not covered here.
|
|
By default, NVM is used to install NodeJS, but you can install it any way you want.
|
|
|
|
This is based on [SvelteKit's instructions](https://kit.svelte.dev/docs/adapter-node#deploying)
|
|
|
|
On your server, install the requirements:
|
|
- Apache2 HTTP Server
|
|
- NodeJS (via [NVM](https://github.com/nvm-sh/nvm))
|
|
|
|
#### On your server
|
|
|
|
Create a directory for the app. This will be called `$APP_DIR` from now on.
|
|
|
|
Place `package.json`, `apache2.conf.EXAMPLE`, `moshing-mammut.service.EXAMPLE` and `start.sh.EXAMPLE` in this directory.
|
|
|
|
Copy `apache2.conf.EXAMPLE` to `/etc/apache2/sites-available/moshingmammut.conf` and replace `ServerName` with your
|
|
Domain. If you do not need or want SSL support, remove the whole `<IfModule mod_ssl.c>` block.
|
|
If you do, add the path to your SSLCertificateFile and SSLCertificateKeyFile.
|
|
|
|
Copy `moshing-mammut.service.EXAMPLE` to `/etc/systemd/system/moshing-mammut.service`
|
|
and replace `/PATH_TO_MOSHING_MAMMUT` with your `$APP_DIR`. Also replace `MOSHING_MAMMUT_USER` with the user you want
|
|
to run the app as.
|
|
|
|
Rename `start.sh.EXAMPLE` to `start.sh` and replace `/PATH_TO_YOUR_NVM/.nvm/nvm.sh` with the path to your NVM
|
|
installation.
|
|
If you do not have NVM installed, simply remove the line and make sure your node executable can be found either by
|
|
specifying the full path or by adding it to your $PATH.
|
|
|
|
Run `npm ci --omit dev` to install the dependencies.
|
|
|
|
#### On your development machine
|
|
|
|
Copy `.env.EXAMPLE` to `.env` and add your `YOUTUBE_API_KEY`.
|
|
To obtain one follow [YouTube's guide](https://developers.google.com/youtube/registering_an_application) to create an
|
|
*API key*. As soon as #13 is implemented, this will be optional!
|
|
|
|
Run `npm run build` and copy the output folder, usually `build` to `$APP_DIR` on your server.
|
|
|
|
#### On your server again
|
|
|
|
Now, you are ready to start everything up.
|
|
|
|
Enable the site in Apache2 by running `a2ensite moshingmammut.conf`.
|
|
|
|
Create and start the system service by running `sudo systemctl enable moshing-mammut.service`
|
|
and then `service moshing-mammut start`.
|
|
|
|
Verify that everything is okay with `service moshing-mammut status`.
|
|
|
|
The app should now be reachable on http://localhost:3000 or whatever you configured your domain to be!
|
|
|