yarn.social
- 0 ratings
Self-Hosted, Twitter™-like Decentralised micro-logging platform. No ads, no tracking, your content, your data.
Deploy this app to Linode with a free $100 credit!
View the chinese version of this document
As a first point, please try to use one of the pre-built binaries that are available on the Releases page.
We provide Homebrew formulae for macOS users for both the
command-line client (yarnc) as well as the server (yarnd).
brew tap yarnsocial/yarn https://git.mills.io/yarnsocial/homebrew-yarn.git
brew install yarnRun the server:
yarndRun the command-line client:
yarncThis is an option if you are familiar with Go development.
git clone https://git.mills.io/yarnsocial/yarn.gitLinux, macOS:
make deps-dev packages. Consult your distribution's package
repository for availability and names.
FreeBSD:
gmakepkgconf that brings pkg-configgmake depsLinux, macOS:
make servermake climake helpFreeBSD:
gmake```#!console $ ./yarnc login INFO[0000] Using config file: /Users/prologic/.twt.yaml Username:
2. Viewing your timeline
```#!console
$ ./yarnc 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``#!console
$ ./yarnc post
INFO[0000] Using config file: /Users/prologic/.twt.yaml
Testingyarn` the command-line client
INFO[0015] posting twt...
INFO[0016] post successful
For additional help on using the `yarnc` command-line client:
```#!console
$ yarnc help
This is the command-line client for Yarn.social pods running
yarnd. This tool allows a user to interact with a pod to view their timeline,
following feeds, make posts and managing their account.
Usage:
yarnc [command]
Available Commands:
completion generate the autocompletion script for the specified shell
help Help about any command
login Login and authenticate to a Yarn.social pod
post Post a new twt to a Yarn.social pod
stats Parses and performs statistical analytis on a Twtxt feed given a URL or local file
timeline Display your timeline
Flags:
-c, --config string set a custom config file (default "/Users/prologic/.yarnc.yml")
-D, --debug Enable debug logging
-h, --help help for yarnc
-t, --token string yarnd API token to use to authenticate to endpoints (default "$YARNC_TOKEN")
-U, --uri string yarnd API endpoint URI to connect to (default "http://localhost:8000/api/v1/")
Use "yarnc [command] --help" for more information about a command.Visit: deployment
Run the compose configuration:
docker-compose up -dThen visit: http://localhost:8000/
Run yarnd:
yarnd -RNOTE: 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 or via environment variables.
To view the available options simply run:
$ ./yarnd --helpValid environment value names are the long-option version of a flag in all uppercase with dashes repalced by an underscore _.
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)-n <name> to give your pod a unique name.-u <url> the base url (public facing) of how your pod will be reahced on the web.-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=usernameADMIN_EMAIL=emailIn 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_KEYCOOKIE_SECRETMAGICLINK_SECRETThese 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 1There is a shell script in ./tools/gen-secrets.sh you can use to conveniently generate the required secrets for a production pod. The output is designed to by copy/pasted into a docker-compose.yml file with the right indentation.
DO NOT publish or share these values. BE SURE to only set them as env vars.
NOTE: The Dockerfile specifies that the container run as
the user yarnd with uid=1000. Be sure that any volume(s) you
mount into your container and use as the data storage (-d/--data)
path and database storage path (-s/--store) is correctly configured
to have the correct user/group ownership. e.g: chorn -R 1000:1000 /data
You can deploy yarnd to a Docker Swarm
cluster by utilising the provided yarn.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 yarn.ymlInterested in contributing to this project? You are welcome! Here are some ways you can contribute:
Please see the Contributing Guidelines and checkout the Developer Documentation or over at /docs.
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.
yarn is licensed under the terms of the AGPLv3 License
Please login to review this project.
No reviews for this project yet.
Free and open-source way to self-host private forums for gr…
A alternative front end to twitter.
Real-time, markdown-enabled comment engine powered by level…
Comments (0)
Please login to join the discussion on this project.