readas

README

Read.as

Read.as is a free and open-source long-form reader built on open web protocols (specifically ActivityPub). It helps you gather and curate things to read in a peaceful space.

It's written in Go (golang), and aims to use (minimal) plain Javascript on the frontend.

You can support the development of this project on Patreon or Liberapay, or by becoming a Write.as subscriber.

Features

• Read Articles from the fediverse
• Follow fediverse users via ActivityPub
• Single-user mode

Requirements

• OpenSSL
• MySQL

Additional requirements for development

• Go 1.10+
• Node.js

Getting Started

# Set up database
# - Log into MySQL and run:
# CREATE DATABASE readas;
# - Import the schema:
mysql -u YOURUSERNAME -p readas < schema.sql

# Install the application
go get github.com/writeas/Read.as
cd $GOPATH/src/github.com/writeas/Read.as
make install

# Option 1: quick start
export RA_MYSQL_CONNECTION="YOURUSERNAME:YOURPASSWORD@tcp(localhost:3306)/readas"
readas -h "http://localhost:8080" -p 8080

# Option 2: configure and run
# Edit configuration
cp config.example.json config.json
vi config.json

# Create initial account
readas --user matt --pass hunter2

# Launch server
readas

Configuration

host or the -h option should be the public-facing URL your site is hosted at, including the scheme, and without a trailing slash.

port or the -p option will be the port your server runs on. In production, add a reverse proxy like nginx in front of the app and point to localhost:PORT.

For mysql_connection, replace YOURUSERNAME and YOURPASSWORD with your MySQL authentication information, and readas with your database name.

By default, you'll see your site at localhost:8080. Be sure to update the host/-h option accordingly when running locally.

Customizing

Go to the users table in your database to update your account's display name and summary.

Deployment

Use in production at your own risk. This is very early software. Things will change and permanently break without notice, and support is minimal or non-existent while in version 0.x.

Run:

./build.sh

Then copy the generated build directory to your server, into a place like /var/app/readas. Add a reverse proxy like Nginx, export your production RA_MYSQL_CONNECTION string on your machine, and from your install directory, run readas -h "https://yourdomain.com".

Development

After updating styles, run make.

After changing any code, run go install ./cmd/readas && readas -h "http://localhost:8080"

Contributing

Feel free to open issues for any bugs you encounter, and submit any pull requests you think would be useful. To request features and discuss development, please see our forum.

Documentation

Index

• func Serve()
• type LocalUser
  • func (u *LocalUser) AccountRoot(app *app) string
  • func (u *LocalUser) AsPerson(app *app) *activitystreams.Person
• type Post
  • func (p *Post) DisplayTitle() string
  • func (p *Post) Published8601() string
  • func (p *Post) PublishedDate() string
  • func (p *Post) SanitaryContent() template.HTML
  • func (p *Post) Summary() string
• type User
  • func (u *User) AsPerson() *activitystreams.Person
• type WebfingerResult

Functions

func Serve

func Serve()

Types

type LocalUser

type LocalUser struct {
	ID                int64  `json:"-"`
	PreferredUsername string `json:"preferredUsername"`
	HashedPass        []byte `json:"-"`
	Name              string `json:"name"`
	Summary           string `json:"summary"`
	// contains filtered or unexported fields
}

LocalUser is a local user

func (*LocalUser) AccountRoot

func (u *LocalUser) AccountRoot(app *app) string

func (*LocalUser) AsPerson

func (u *LocalUser) AsPerson(app *app) *activitystreams.Person

type Post

type Post struct {
	ID         int64
	OwnerID    int64
	ActivityID string
	Type       string
	Published  time.Time
	URL        string
	Name       string
	Content    string

	IsInFeed bool

	Owner *User
	// contains filtered or unexported fields
}

func (*Post) DisplayTitle

func (p *Post) DisplayTitle() string

func (*Post) Published8601

func (p *Post) Published8601() string

func (*Post) PublishedDate

func (p *Post) PublishedDate() string

func (*Post) SanitaryContent

func (p *Post) SanitaryContent() template.HTML

func (*Post) Summary

func (p *Post) Summary() string

type User

type User struct {
	activitystreams.Person
	ID      int64     `json:"-"`
	Host    string    `json:"-"`
	Created time.Time `json:"-"`
}

User is a remote user

func (*User) AsPerson

func (u *User) AsPerson() *activitystreams.Person

type WebfingerResult

type WebfingerResult struct {
	ActorIRI string
	Username string
	Host     string
}