pallium

command module
Version: v0.0.0-...-1cbd5f8 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 15, 2015 License: Apache-2.0 Imports: 3 Imported by: 0

README

pallium

Pallium is an experimental golang homeserver implementation for the Matrix.org standard.

Matrix is a new open standard for interoperable Instant Messaging and VoIP, providing pragmatic HTTP APIs and open source reference implementations for creating and running your own real-time communication infrastructure.

To get up and running:

# get the latest Go from https://golang.org/dl/
# and define a GOPATH for your Go workspace if you don't have one already:
export GOPATH=~/go
mkdir -p $GOPATH

# grab the latest pallium with all its dependencies:
go get github.com/KoFish/pallium

# set up a default config
cd $GOPATH/github.com/KoFish/pallium
cp config.json.dist config.json

# edit the hostname param in config.json to specify how the server
# should refer to itself and expect to be accessed from the internet
# (use localhost for local experimentation)

# set the server running. This will create a local sqlite db for storage
# and start listening for traffic.
$GOPATH/bin/pallium

To use the server, select a client from matrix.org. For instance, to use the webclient hosted at https://matrix.org/beta against your new server, just specify the URL of your pallium server (e.g. http://localhost:8008) as the "Home Server" parameter on the login and registration pages rather than http://matrix.org. You do not need to enter the captcha, as pallium does not support captcha-based registration yet.

Currently pallium does not support the full Matrix API set, so the webclient may well not work correctly

Alternatively, to run your own webclient:

git clone http://github.com/matrix-org/matrix-angular-sdk

...and follow the instructions in syweb/webclient/README

For more information on Matrix, please see Matrix.org, the Matrix Specification or Synapse - the Python reference Matrix home server implementation.

Documentation

Overview

Pallium is a homeserver for http://matrix.org implemented in Go.

Source Files

Directories

Path Synopsis
The API package is a the transport independent logic to perform the Matrix API functionalities from the specification.
The API package is a the transport independent logic to perform the Matrix API functionalities from the specification.
Package handling the static configurations of the homeserver
Package handling the static configurations of the homeserver
The matrix package supplies constants and datastructures that are defined by the matrix protocol at http://matrix.org/docs/spec/ TODO: Should be deleted TODO: Should be deleted
The matrix package supplies constants and datastructures that are defined by the matrix protocol at http://matrix.org/docs/spec/ TODO: Should be deleted TODO: Should be deleted
TODO(): This code needs to be moved to some other place in pallium.
TODO(): This code needs to be moved to some other place in pallium.
Handles login requests.
Handles login requests.
The storage package manages setting up the database ond knows how to fetch and update all relevant data.
The storage package manages setting up the database ond knows how to fetch and update all relevant data.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL