1
0
mirror of https://github.com/funkypenguin/geek-cookbook/ synced 2025-12-13 09:46:23 +00:00

Tidy up README and remove gitlab CI config

This commit is contained in:
David Young
2017-08-03 07:49:41 +12:00
parent 98683ed61f
commit 5757193105
4 changed files with 43 additions and 55 deletions

View File

@@ -1,45 +0,0 @@
stages:
- build
- test
- deploy
image: python:alpine
build site:
stage: build
script:
- pip install mkdocs mkdocs-material pymdown-extensions
- mkdocs build
- mv site public
artifacts:
expire_in: 1 day
paths:
- public
test site:
stage: test
script:
- echo fake result as a placeholder
deploy dev:
image: garland/docker-s3cmd
stage: deploy
environment: development
except:
- master
script:
- export LC_ALL=C.UTF-8
- export LANG=C.UTF-8
- s3cmd --no-mime-magic --access_key=$ACCESS_KEY --secret_key=$SECRET_KEY --acl-public --delete-removed --delete-after --no-ssl --host=$S3HOST --host-bucket='$S3HOSTBUCKET' sync public s3://geeks-cookbook-dev
deploy prod:
image: garland/docker-s3cmd
stage: deploy
environment: production
only:
- master
script:
- apk add rsync openssh --no-cache
- export LC_ALL=C.UTF-8
- export LANG=C.UTF-8
- s3cmd --no-mime-magic --access_key=$ACCESS_KEY --secret_key=$SECRET_KEY --acl-public --delete-removed --delete-after --no-ssl --host=$S3HOST --host-bucket='$S3HOSTBUCKET' sync public s3://geeks-cookbook

39
README.md Normal file
View File

@@ -0,0 +1,39 @@
# What is this?
The "**[Geek's Cookbook](https://geek-cookbook.funkypenguin.co.nz)**" is a collection of guides for establishing your own highly-available docker container cluster (swarm). This swarm enables you to run self-hosted services such as [GitLab](https://gitlab.com/), [Plex](https://www.plex.tv/), [NextCloud](https://nextcloud.com), etc.
## Who is this for?
You already have a familiarity with concepts such as [virtual](https://libvirt.org/) [machines](https://www.virtualbox.org/), [Docker](https://www.docker.com/) containers, [LetsEncrypt SSL certificates](https://letsencrypt.org/), databases, and command-line interfaces.
You've probably played with self-hosting some mainstream apps yourself, like [Plex](https://www.plex.tv/), [OwnCloud](https://owncloud.org/), [Wordpress](https://wordpress.org/) or even [SandStorm](https://sandstorm.io/).
## Why should I read this?
So if you're familiar enough with the tools, and you've done self-hosting before, why would you read this book?
1. You want to upskill. You want to do container orchestration, LetsEncrypt certificates, git collaboration.
2. You want to play. You want a safe sandbox to test new tools, keeping the ones you want and tossing the ones you don't.
3. You want reliability. Once you go from __playing__ with a tool to actually __using__ it, you want it to be available when you need it. Having to "_quickly ssh into the host and restart the webserver_" doesn't cut it when your wife wants to know why her phone won't sync!
## What do you want from me?
I want your money.
No, seriously (_but yes, I do want your money - see below_), If the above applies to you, then you're like me. I want everything I wrote above, so I ended up learning all this as I went along. I enjoy it, and I'm good at it. So I created this website, partly to make sure I documented my own setup properly.
## How can I support you?
### Buy my book 📖
I'm also writing it as a formal book, on Leanpub (https://leanpub.com/geeks-cookbook). Buy it for $0.99 (which is really just a token gesture of support) - you can get it for free (in PDF, mobi, or epub format), or pay me what you think it's worth!
### [Patreonize me 💰](https://www.patreon.com/funkypenguin)
<a href="https://www.patreon.com/bePatron?u=6982506" data-patreon-widget-type="become-patron-button">Become a Patron!</a><script async src="https://c6.patreon.com/becomePatronButton.bundle.js"></script>
- [My Patreon page](https://www.patreon.com/funkypenguin)!
### Hire me 🏢
Need some system design work done? I do freelance consulting - [contact](https://www.funkypenguin.co.nz/contact/) me for details.

View File

@@ -1,12 +1,6 @@
# Index
# What is this?
The "**Geek's Cookbook**" is a collection of guides for establishing your own highly-available "private cloud" [^1]. This cloud enables you to run self-hosted services such as [GitLab](gitlab), [Plex](plex), [NextCloud](nextcloud), etc.
[^1]: Sorry for the buzzword, I couldn't think of a better description!
[plex]: https://www.plex.tv/
[gitlab]: https://gitlab.com/
[nextcloud]: https://nextcloud.com/
The "**[Geek's Cookbook](https://geek-cookbook.funkypenguin.co.nz)**" is a collection of guides for establishing your own highly-available docker container cluster (swarm). This swarm enables you to run self-hosted services such as [GitLab](https://gitlab.com/), [Plex](https://www.plex.tv/), [NextCloud](https://nextcloud.com), etc.
## Who is this for?

View File

@@ -25,8 +25,8 @@ pages:
- Shared Storage (Ceph): ha-docker-swarm/shared-storage-ceph.md
- Shared Storage (GlusterFS): ha-docker-swarm/shared-storage-gluster.md
- Keepalived: ha-docker-swarm/keepalived.md
- Docker Swarm Mode: ha-docker-swarm/docker-swarm-mode.md
- Traefik: ha-docker-swarm/traefik.md
- Docker Swarm Mode: ha-docker-swarm/docker-swarm-mode.md
- Recommended:
- Mail Server: recipies/mail.md
- GitLab: recipies/gitlab.md