Logux is a client-server communication protocol. It synchronizes actions 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 actions between clients, not yet having many syntax sugar that we've planned for future.
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 server.js
with this boilerplate:
const Server = require('logux-server').Server
const app = new Server(
Server.loadOptions(process, {
subprotocol: '1.0.0',
supports: '1.x',
root: __dirname
})
)
app.auth((userId, token) => {
// TODO Check token and return a Promise with true or false.
})
app.listen()
Logux is a communication protocol. It doesn’t know anything about your database. You need to write custom logic inside your action callbacks.
app.type('CHANGE_NAME', {
access (action, meta, userId) {
return action.user === userId
}
process (action) {
users.find({ id: action.user }).then(user => {
user.update({ name: action.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 action listener. For one, you may just call the legacy REST API:
process (action) {
request.put(`https://example.com/users/${action.user}`).form({
name: action.name
})
}
You can run your server with:
npm start
Use ws:https://localhost:1337
URL in Logux Client.
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.
Use your favorite DevOps tools to start Logux server in production
mode:
NODE_ENV=production npm start
You DevOps tools could set Logux Server options via arguments or environment variables:
Command-line | Environment | Description |
---|---|---|
-h , --host |
LOGUX_HOST |
Host to bind server |
-p , --port |
LOGUX_PORT |
Port to bind server |
-k , --key |
LOGUX_KEY |
Path to SSL key |
-c , --cert |
LOGUX_CERT |
Path to SSL certificate |