📕 yarn is a Self-Hosted, Twitter™-like Decentralised microBlogging platform. No ads, no tracking, your content, your data! https://yarn.social/
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
James Mills 1727771047
Upgrade to bitcask v1.0.0
2 days ago
.chglog Move source code and rename Go module to git.mills.io/yarnsocial/yarn 2 weeks ago
client More fixes 2 weeks ago
cmd Fix version string of server binary 4 days ago
contrib Updated Grafana Dashboard 11 months ago
data Adds support for Private Messaging for users on a pod (#307) 7 months ago
docs Move source code and rename Go module to git.mills.io/yarnsocial/yarn 2 weeks ago
internal Fix version string of server binary 4 days ago
tests Add debug-only memory profiler to debug some memory bloat 11 months ago
tools Add a blake2b_base32 cli tool 3 weeks ago
types Move source code and rename Go module to git.mills.io/yarnsocial/yarn 2 weeks ago
.dockerignore Rename the binaries to yarn and yarnd 2 weeks ago
.drone.yml Fix Drone CI config and add make deps back 5 days ago
.gitignore Fix .gitignore 2 weeks ago
.goreleaser-darwin.yml Move source code and rename Go module to git.mills.io/yarnsocial/yarn 2 weeks ago
.goreleaser-linux.yml Move source code and rename Go module to git.mills.io/yarnsocial/yarn 2 weeks ago
.goreleaser.yml Move source code and rename Go module to git.mills.io/yarnsocial/yarn 2 weeks ago
AUTHORS Update AUTHORS (#131) 11 months ago
CHANGELOG.md Propose specification on Multi User User-Agent Extension (#326) 6 months ago
CODE_OF_CONDUCT.md Add Contributor Code of Conduct 12 months ago
CONTRIBUTING.md Add Contributing guideline and TODO 1 year ago
Dockerfile Rename the binaries to yarn and yarnd 2 weeks ago
Dockerfile.dev Fixed missing lextwt for Dockerfile.dev 2 weeks ago
LICENSE Fix LICENSE file 8 months ago
Makefile Update docker image publication 2 weeks ago
README.md Update README 2 weeks ago
README_ZH.md Rename the binaries to yarn and yarnd 2 weeks ago
Taskfile.yml Rename the binaries to yarn and yarnd 2 weeks ago
doc.go More fixes 2 weeks ago
docker-compose.yml Fix docker-compose 2 weeks ago
docker-stack.yml Added improved docker-compose.yml and docker-stack.yml configs for better local dev and simpler production deployment example (both tested on macOS) 6 months ago
go.mod Upgrade to bitcask v1.0.0 2 days ago
go.sum Upgrade to bitcask v1.0.0 2 days ago
version.go More fixes 2 weeks ago

README.md

yarn

Build Status GoDoc

📕 yarn is a Self-Hosted, Twitter™-like Decentralised micro-Blogging platform. No ads, no tracking, your content, your data!

Technically twtxt is a multi-user twtxt client in the form of a web app and api. It supports multiple users and also hosts user feeds directly and provides a familiar "social" experience with minimal user profiles.

It also supports "rich" text by utilising Markdown as well as multimedia such as photos, videos and even audio.

There is also a set of Mobile Apps available for both the App Store and Play Store.

There is also a publicly (free) available Pod available at:

NOTE: I, James Mills, run this first (of which I hope to be many) twtxt instance on pretty cheap hardware on a limited budget. Please use it fairly so everyone can enjoy using it equally! Please be sure to read the /privacy policy before signing up (pretty straight forward) and happy Twt'ing! 🤗

Sponsor this project to support the development of new features, improving existings ones and fix bugs! Or contact Support for help with running your own Pod! Or host your own Twtxt feed and support our Extensions.

Demo_1

Mobile Apps

Goryon for Twt available for both the App Store and Play Store.

Install Goryon today on your mobile device here

Hosted Pods

This project offers fully-managed, 1-click instances of this platform we call Twt.social pods.

Please visit Twt.social to get your pod today!

NOTE: As of 15th Aug 2020 (comment announcement blog), this is completely FREE and we invite anyone to contact us for an invite code to be one of the first few pod owners!

Installation

Pre-built Binaries

NOTE: Please don't use the pre-built binaries until Issue #250 is resolved. Please build from source or use the Docker Images. Thank you. 🙇‍♂️

As a first point, please try to use one of the pre-built binaries that are available on the Releases page.

Using Homebrew

We provide Homebrew formulae for macOS users for both the command-line client (yarn) as well as the server (yarnd).

brew tap jointwt/twtxt
brew install twtxt

Run the server:

yarnd

Run the command-line client:

yarn

Building from source

This is an option if you are familiar with Go development.

  1. Clone this repository (this is important)
git clone https://git.mills.io/yarnsocial/yarn.git
  1. Install required dependencies (this is important)

Linux, macOS:

make deps

Note that in order to get the media upload functions to work, you need to install ffmpeg and its associated -dev packages. Consult your distribution's package repository for availability and names.

FreeBSD:

  • Install gmake
  • Install pkgconf that brings pkg-config gmake deps
  1. Build the binaries

Linux, macOS:

make

FreeBSD:

gmake

Usage

Command-line Client

  1. Login to your Twt.social pod:
$ ./yarn login
INFO[0000] Using config file: /Users/prologic/.twt.yaml
Username:
  1. Viewing your timeline
$ ./yarn timeline
INFO[0000] Using config file: /Users/prologic/.twt.yaml
> prologic (50 minutes ago)
Hey @rosaelefanten 👋 Nice to see you have a Twtxt feed! Saw your [Tweet](https://twitter.com/koehr_in/status/1326914925348982784?s=20) (_or at least I assume it was yours?_). Never heard of `aria2c` till now! 🤣 TIL

> dilbert (2 hours ago)
Angry Techn Writers ‣ https://dilbert.com/strip/2020-11-14
  1. Making a Twt (post):
$ ./yarn post
INFO[0000] Using config file: /Users/prologic/.twt.yaml
Testing `yarn` the command-line client
INFO[0015] posting twt...
INFO[0016] post successful

Deploy with Docker Compose

Run the compose configuration:

docker-compose up -d

Then visit: http://localhost:8000/

Web App

Run yarnd:

yarnd -R

NOTE: Registrations are disabled by default so hence the -R flag above.

Then visit: http://localhost:8000/

You can configure other options by specifying them on the command-line:

$ ./yarnd --help
Usage of ./yarnd:
  -E, --admin-email string          default admin user email (default "support@twt.social")
  -N, --admin-name string           default admin user name (default "Administrator")
  -A, --admin-user string           default admin user to use (default "admin")
      --api-session-time duration   timeout for api tokens to expire (default 240h0m0s)
      --api-signing-key string      secret to use for signing api tokens (default "PLEASE_CHANGE_ME!!!")
  -u, --base-url string             base url to use (default "http://0.0.0.0:8000")
  -b, --bind string                 [int]:<port> to bind to (default "0.0.0.0:8000")
      --cookie-secret string        cookie secret to use secure sessions (default "PLEASE_CHANGE_ME!!!")
  -d, --data string                 data directory (default "./data")
  -D, --debug                       enable debug logging
      --feed-sources strings        external feed sources for discovery of other feeds (default [https://feeds.twtxt.net/we-are-feeds.txt,https://raw.githubusercontent.com/jointwt/we-are-twtxt/master/we-are-bots.txt,https://raw.githubusercontent.com/jointwt/we-are-twtxt/master/we-are-twtxt.txt])
      --magiclink-secret string     magiclink secret to use for password reset tokens (default "PLEASE_CHANGE_ME!!!")
  -F, --max-fetch-limit int         maximum feed fetch limit in bytes (default 2097152)
  -L, --max-twt-length int          maximum length of posts (default 288)
  -U, --max-upload-size int         maximum upload size of media (default 16777216)
  -n, --name string                 set the pod's name (default "twtxt.net")
  -O, --open-profiles               whether or not to have open user profiles
  -R, --open-registrations          whether or not to have open user registgration
      --session-expiry duration     timeout for sessions to expire (default 240h0m0s)
      --smtp-from string            SMTP From to use for email sending (default "PLEASE_CHANGE_ME!!!")
      --smtp-host string            SMTP Host to use for email sending (default "smtp.gmail.com")
      --smtp-pass string            SMTP Pass to use for email sending (default "PLEASE_CHANGE_ME!!!")
      --smtp-port int               SMTP Port to use for email sending (default 587)
      --smtp-user string            SMTP User to use for email sending (default "PLEASE_CHANGE_ME!!!")
  -s, --store string                store to use (default "bitcask://twtxt.db")
  -t, --theme string                set the default theme (default "dark")
  -T, --twts-per-page int           maximum twts per page to display (default 50)
  -v, --version                     display version information
      --whitelist-domain strings    whitelist of external domains to permit for display of inline images (default [imgur\.com,giphy\.com,reactiongifs\.com,githubusercontent\.com])
pflag: help requested

Configuring your Pod

At a bare minimum you should set the following options:

  • -d /path/to/data
  • -s bitcask:///path/to/data/twtxt.db (we will likely simplify/default this)
  • -R to enable open registrations.
  • -O to enable open profiles.

Most other configuration values should be done via environment variables.

It is recommended you pick an account you want to use to "administer" the pod with and set the following environment values:

  • ADMIN_USER=username
  • ADMIN_EMAIL=email

In order to configure email settings for password recovery and the /support and /abuse endpoints, you should set appropriate SMTP_ values.

It is highly recommended you also set the following values to secure your Pod:

  • API_SIGNING_KEY
  • COOKIE_SECRET
  • MAGICLINK_SECRET

These values should be generated with a secure random number generator and be of length 64 characters long. You can use the following shell snippet to generate secrets for your pod for the above values:

$ cat /dev/urandom | tr -dc 'a-zA-Z0-9' | fold -w 64 | head -n 1

DO NOT publish or share these values. BE SURE to only set them as env vars.

Production Deployments

Docker Swarm

You can deploy twtxt to a Docker Swarm cluster by utilising the provided twtxt.yaml Docker Stack. This also depends on and uses the Traefik ingress load balancer so you must also have that configured and running in your cluster appropriately.

docker stack deploy -c twtxt.yml

In the News

Sponsor

Support the ongoing development of twtxt!

Sponsor

Contributing

Interested in contributing to this project? You are welcome! Here are some ways you can contribute:

  • File an Issue -- For a bug, or interesting idea you have for a new feature or just general questions.
  • Submit a Pull-Request or two! We welcome all PR(s) that improve the project!

Please see the Contributing Guidelines and checkout the Developer Documentation or over at /docs.

Please note: If you wish to contribute to this project off-Github please get in touch with us and let us know! We have this project mirrored to private Git hosting using Gitea and can fully support external collaborator this way (even via email!).

Contributors

Thank you to all those that have contributed to this project, battle-tested it, used it in their own projects or products, fixed bugs, improved performance and even fix tiny typos in documentation! Thank you and keep contributing!

You can find an AUTHORS file where we keep a list of contributors to the project. If you contribute a PR please consider adding your name there. There is also Github's own Contributors statistics.

Stargazers over time

Stargazers over time

License

twtxt is licensed under the terms of the MIT License