Skip to content

grundstein/grundstein

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Grundstein (plural Grundsteine) [german]

  • A ceremonial stone set at the corner of a building.
  • By extension, that which is prominent, fundamental, noteworthy, or central.

via: wiktionary


WIP. NOT IN PRODUCTION, TESTED AND/OR BENCHMARKED YET!

grundstein

runs a production ci/cd environment for us (and you?).

it is built to serve magic pages and apis.

we also use it for the Artificial Museum.

requirements:

server

tested on ubuntu.

expected server packages: systemd, apt, ssh, and bash.

grundsteinlegung.sh is a bash script and gets sent to the server via ssh, all other dependencies get installed automagically.

might work on other linuxes, if systemd and apt exist there.

development

expects docker and nodejs to be installed on your computer.

features:

user management

adds grundstein user(s)

installs it's own dependencies

nodejs, git, makepasswd, curl, certbot

certificates

generates letsencrypt certificates using certbot and certbot-dns-digitalocean

systemd init

sets up grundstein systemd.service files and starts and enables the services.

logging

uses systemd and journalctl for log management.

installation

npm i -g grundstein

custom configuration

grundstein needs a configuration to work.

the easiest way to get started is to perform a grundsteinlegung.

git clone git://github.com/grundstein/legung ./cloud.domain.name

cd cloud.domain.name

npm install

# add a digitalocean api token to .secrets/digitalocean.ini
# to generate letsencrypt certificates.
# at the moment, this also requires you to use the digitalocean nameservers for your domain!

# start dev server
npm start

# deploy to your own server (after editing /grundstein-config.mjs to add your ip)
npm run prod
suggestion

we use a digitalocean floating ip, this allows us to setup a separate pod, prepare it, and then just reassign the ip address to the new version.

by leaving a number of old pods alive, we can also rollback easily.

all of this without touching dns.

TODO:
  • create pods through digitalocean api

  • name them by git hash

  • keep 3 versions alive at all times

  • add functionality to allow custom cloud apis

changelog

v0.0.1-alpha.0

first release

v0.0.1-alpha.1

  • fix systemd docker container handling
  • update dependencies

v0.0.1 - unreleased

...

About

grundsteinlegung. init bash scripts. only server requirements: bash, ssh.

Resources

License

Stars

Watchers

Forks

Packages

No packages published