hkxserver

command module
v0.8.6 Latest Latest
Warning

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

Go to latest
Published: Dec 24, 2021 License: AGPL-3.0 Imports: 35 Imported by: 0

README

HORKRUXES

A decentralized social network based on a distributed authentication system.

Installation

Unlike Mastodont, the horkrux installation on a linux server is DEAD SIMPLE.

Basic installation, 30s chrono
mkdir horkruxes && cd horkruxes
wget https://github.com/horkruxes/hkxserver/releases/latest/download/hkxserver_linux_amd64.tar.gz
tar -xzvf horkruxes_linux_amd64.tar.gz #insert version or use auto-completion
./horkruxes version
./horkruxes
HTTPS with nginx installed

Copy this to /etc/nginx/sites-available/horkruxes

server {
    server_name your.server.name; # Use your domain name
    location / {
        proxy_pass http://localhost:80; # You can change the port in hkxconfig.toml
    }
}

Then run

sudo ln -s /etc/nginx/sites-available/horkruxes /etc/nginx/sites-enabled/horkruxes
sudo systemctl restart nginx
sudo certbot --nginx #For HTTPS

And that's all folks

What is signed ?

A list of bytes generated from strings with different encodings, in this order:

  • The message (utf-8)
  • The public key (base64)
  • The Displayed Name (utf-8)
Development

I like to use air to run my projects.

go generate ./... # Generates Tailwind styles
ENV=production go generate ./... # Optimize for production
go run .

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
Package docs GENERATED BY THE COMMAND ABOVE; DO NOT EDIT This file was generated by swaggo/swag
Package docs GENERATED BY THE COMMAND ABOVE; DO NOT EDIT This file was generated by swaggo/swag

Jump to

Keyboard shortcuts

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