Logux Server

Logux is a client-server communication protocol. It synchronizes events between clients and server logs.

This framework helps you to write Logux server and define back-end callbacks for each client’s event type.

This is a first proof-of-concept version. It simply synchronizes all the events between clients, not yet having many syntax sugar that we've planned for future.

Getting Started

Installation

Install Node.js.

Create new Node.js project:

mkdir PROJECT_NAME
cd PROJECT_NAME
npm init

Install Logux Server:

npm install --save logux-server logux-core

Create Main File

Create server.js with this boilerplate:

const cleanEvery = require('logux-core').cleanEvery
const Server = require('logux-server').Server

const app = new Server({
  subprotocol: '1.0.0',
  supports: '1.x',
  root: __dirname
})

app.auth(token => {
  // TODO Return user by token or false on bad token.
})

app.log.on('event', (event, meta) => {
  // TODO Do something on client event. Write to database, ask other service.
})

cleanEvery(app.log, 1000)
app.log.keep((event, meta) => {
  // TODO return true if event should not be removed yet from log
})

if (app.env === 'production') {
  app.listen({ cert: 'cert.pem', key: 'key.pem' })
} else {
  var options = app.loadOptions(process)
  app.listen(options)
}

Available console arguments and environment variables

-h, --help         output usage information
-p, --port [port]  Set up a port
-h, --host [host]  Set up a host
-c, --cert [cert]  Set up a cert
-k, --key  [key]   Set up a key

Write Business Logic

Logux is a communication protocol. It doesn’t know anything about your database. You need to write custom logic inside your event callbacks.

app.log.on('event', (event, meta) => {
  if (event.type === 'changeName') {
    users.find({ id: event.user }).then(user => {
      user.update({ name: event.name })
    })
  }
})

Read logux-core docs for app.log API.

If you already have business logic written in PHP, Ruby, Java — don’t worry. You can do whatever you want in the event listener. For one, you may just call the legacy REST API:

if (event.type === 'changeName') {
  request.put(`http://example.com/users/${event.user}`).form({
    name: event.name
  })
}

Test Your Logic Locally

You can run your server with:

npm start

Use ws://localhost:1337 URL in Logux Client.

Get SSL Certificate

Logux uses WebSockets for communicating between client and server. Without SSL, old proxies and firewalls can block WebSockets connection. Also, SSL will obviously help to prevent many attacks against your server.

Probably the best way to get a free SSL certificate is Let’s Encrypt.

Save certificate PEM-files to cert.pem and key.pem in your project directory or change listen() options to correct certificate paths.

Start Production Server

Use your favorite DevOps tools to start Logux server in production mode:

NODE_ENV=production npm start

sasha-bichkov/logux-server