Skip to content

Alinex Server

server icon

A pre-configured and opinionated but ready to use REST Server which can easily be used as backend to other services or any frontend type. It may come bundled with the alinex-gui.

Big Features:

  • stateless using simple JSON Web Tokens for authentication
  • websocket (Realtime API) or HTTP REST
  • service oriented architecture
  • multiple response formats
  • authorization
  • client and server validation
  • detailed request, error and module logging
  • extensible with own business logic

Requirements

The Alinex Server needs only:

  • one CPU core
  • at least 200 MiB RAM
  • about 500 MiB HDD

To use it on the internet you have to also add a nginx proxy bevor doing HTTPS offloading and port forwarding.

Chapters

Read all about the alinex-server in the chapters (top navigation menu):

Support

I don't give any paid support but you may create GitLab Issues:

  • Bug Reports or Feature: Please make sure to give as much information as possible. And explain how the system should behave in your opinion.
  • Code Fixing or Extending: If you help to develop this package I am thankful. Develop in a fork and make a merge request after done. I will have a look at it.
  • Should anybody be willing to join the core team feel free to ask, too.
  • Any other comment or discussion as far as it is on this package is also kindly accepted.

Please use for all of them the GitLab Issues which only requires you to register with a free account.

Statistics

The following statistics will give you a better understanding about it's complexity. The documentation has 111 pages (in A4 PDF format) and contains 181345 characters. And this package has 4494 lines of code.

The latest version in the repository is Version 1.3.6. It has a size of 3,24MiB in 354 files. The development contains 65 packages (resolved) and 5 of it are from the Alinex project.

Download Documentation

If you want to have an offline access to the documentation, feel free to download the 111 pages PDF Documentation.

License

Alinex Server

Copyright 2018 - 2021 Alexander Schilling (https://gitlab.com/alinex/node-server)

Apache License, Version 2.0

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.