🚀 Launch v0.0.2

Dockerfile

@@ -1,6 +1,15 @@
-FROM node:lts AS runtime
+FROM node:alpine3.20 AS runtime
 WORKDIR /app
 
+# Metadata
+LABEL org.opencontainers.image.title="Blackclip"
+LABEL org.opencontainers.image.vendor="SudoVanilla"
+LABEL org.opencontainers.image.description="Link Sharing"
+LABEL org.opencontainers.image.licenses="AGPL-3.0-or-later"
+LABEL org.opencontainers.image.url="https://ark.sudovanilla.org/Korbs/Blackclip/"
+LABEL org.opencontainers.image.source="https://ark.sudovanilla.org/Korbs/Blackclip/"
+LABEL org.opencontainers.image.version="0.0.2"
+
 # Copy site to Docker image
 COPY . .
 

README.md

@@ -1,2 +1,169 @@
 # BlackClip
 
+BlackClip is a link sharing project, open source and can be self-hosted. 
+
+## Setup with Docker
+
+Create a folder for BlackClip and craete two files, the compose and ENV file:
+```bash
+# Create Folder
+mkdir ./blackclip
+cd ./blackclip
+
+# Create Files
+touch docker-compose.yml
+touch .env
+```
+
+In `docker-compose.yml`:
+```yaml
+services:
+  blackclip:
+    image: oci.registry.sudovanilla.org/blackclip:latest
+    restart: always
+    ports:
+      - 6533:4321
+```
+
+If you need to, you can set BlackClip to any port you want to use, just change `6533`. Do not change `4321`, as this is the port used inside the container. 
+
+In `.env`:
+```env
+# Customization
+Wallpaper="https://random-image-pepebigotes.vercel.app/api/random-image"
+
+# About You
+Name="John Smith"
+Email="j.smith@sudovanilla.org"
+Avatar="/avatar.png"
+
+
+# Links
+Mastodon="https://mastodon.social/@mastodon"
+Tumblr="https://www.tumblr.com/shencomix"
+# Add whatever links you want here, as long as it's supported. Mastodon and Tumblr not required, they're just examples.
+```
+
+## Email
+
+In your `.env` file, there is a `Email` variable that you can set. If set, a button labeled "Email" will show up at the top of that page with your profile, right it's right-hand side. This button will use a `href` parameter, utilzing the `mailto:` protocol. 
+
+SudoVanilla recommends that add something to the email address to prevent spam. A lot of scrapers like to grab `mailto` links and email addresses on websites, since then I recommend adding `-REMOVE-TO-PREVENT-SPAM` to your email address.
+
+Example:
+ - Plain email: `johnsmith@example.org`
+ - Recommended: `johnsmith-REMOVE-TO-PREVENT-SPAM@example.org`
+
+In your email provider, setup an email rule to trash and delete all emails containting the `-REMOVE-TO-PREVENT-SPAM` email address. 
+
+## Supported:
+ - Amazon
+ - AppleBooks
+ - AppleMusic
+ - ApplePodcasts
+ - Appstore
+ - Bandcamp
+ - Behance
+ - Blog
+ - Bluesky
+ - Bookwyrm
+ - Booth
+ - Briar
+ - Cashapp
+ - Castopod
+ - Codeberg
+ - Codepen
+ - Coffee
+ - Cryptpad
+ - Custom
+ - Deezer
+ - DevTo
+ - Discord
+ - EpicGames
+ - Etsy
+ - Facebook
+ - FDroid
+ - Firefish
+ - Figma
+ - Flickr
+ - Firefox
+ - Funkwhale
+ - Friendica
+ - Gdrive
+ - Furaffinity
+ - Gitlab
+ - Github
+ - Hearthisat
+ - Goodreads
+ - Instagram
+ - HumbleBundle
+ - Itchio
+ - Itaku
+ - Kit
+ - Kickstarter
+ - LastFM
+ - KoFi
+ - Letterboxd
+ - Lemmy
+ - Linkedin
+ - Liberapay
+ - Littlelink
+ - Linkstack
+ - Mastodon
+ - Llc
+ - Medium
+ - Matrix
+ - Misskey
+ - Messenger
+ - Odysee
+ - Notion
+ - Openstreetmap
+ - Onlyfans
+ - Patreon
+ - Owncast
+ - Peertube
+ - Paypal
+ - Picarto
+ - Phone
+ - Piwigo
+ - Pinterest
+ - Playstore
+ - Pixelfed
+ - Producthunt
+ - Pleroma
+ - Reddit
+ - Pronounspage
+ - Share
+ - Session
+ - Simplex
+ - Signal
+ - Snapchat
+ - Skoob
+ - Spotify
+ - Soundcloud
+ - Strava
+ - Steam
+ - Telegram
+ - Streams
+ - Throne
+ - Threema
+ - Trakt
+ - Tiktok
+ - Tumblr
+ - Trello
+ - Twitter
+ - Twitch
+ - Unraid
+ - Unity
+ - Upptime
+ - Untappd
+ - Venmo
+ - Vcard
+ - Vrchat
+ - Vimeo
+ - Whatsapp
+ - Website
+ - Xing
+ - Wordpress
+ - YoutubeMusic
+ - Youtube

docker-compose.yml

@@ -1,6 +1,6 @@
 services:
   blackclip:
-    image: docker.io/library/link
-    restart: unless-stopped
+    image: oci.registry.sudovanilla.org/blackclip:latest
+    restart: always
     ports:
-      - 5522:4321
+      - 6533:4321

package.json

@@ -1,19 +1,21 @@
 {
   "name": "blackclip",
   "type": "module",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "scripts": {
     "dev": "astro dev",
     "start": "astro dev",
     "build": "astro build",
     "preview": "astro preview",
-    "astro": "astro"
+    "astro": "astro",
+    "docker:build": "buildah build -t oci.registry.sudovanilla.org/blackclip --no-cache",
+    "docker:push": "buildah push oci.registry.sudovanilla.org/blackclip"
   },
   "dependencies": {
-    "@astrojs/node": "^8.3.1",
-    "astro": "^4.10.3"
+    "@astrojs/node": "^9.0.2",
+    "astro": "^5.1.9"
   },
   "devDependencies": {
-    "sass": "^1.77.5"
+    "sass": "^1.83.4"
   }
 }