Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/khuedoan/nanopaas
NanoPaaS: git push to deploy, implemented in 50 lines of code
https://github.com/khuedoan/nanopaas
Last synced: 13 days ago
JSON representation
NanoPaaS: git push to deploy, implemented in 50 lines of code
- Host: GitHub
- URL: https://github.com/khuedoan/nanopaas
- Owner: khuedoan
- License: gpl-3.0
- Created: 2024-05-28T01:19:42.000Z (6 months ago)
- Default Branch: master
- Last Pushed: 2024-05-28T16:46:56.000Z (5 months ago)
- Last Synced: 2024-10-06T19:41:34.086Z (about 1 month ago)
- Language: Shell
- Homepage:
- Size: 17.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# NanoPaaS
Self-hosting your own code shouldn't be complicated if you don't need advanced features.
You've developed a small application and now you want to share it with the world, what's next?
## Requirements
Application:
- Written in one of the supported languages: Go, Java, Node.js, PHP, Python, Ruby, Scala
Server:
- A Linux server with public IP (most cloud providers offer a free tier with a small server)
- A domain pointed to that IP (see below if you just need a free one for development)
- Packages: `git`, `docker`
- Firewall ports:
| Port | Protocol | Description |
| ---- | -------- | ----------- |
| 22 | TCP | SSH |
| 80 | TCP | HTTP |
| 443 | TCP | HTTPS |
## Usage
1. Fork this repository (optional but recommended) and clone it to your server:
```sh
git clone [email protected]//nanopaas
cd nanopaas
```
2. Initialize your first project:
```sh
# name branch
./create.sh example-service master
```
3. Add the service to the compose file (an entry for `example-service` is already present, you just need to update the domain and port):
```sh
vim compose.yaml
```
4. Go back to you application repo and add the server to your git remote:
```sh
git remote add deploy @:
```
5. Deploy!
```sh
git push deploy
```
Wanna deploy another app? Just repeat steps 2 to 5 :)
## How it works
- When you create a new application with `./create.sh`, it initializes an empty repo with some configuration, most notably setting `core.hookPath` to the [`./hooks`](./hooks) directory.
- When you set up a new `deploy` git remote and push, git on the server automatically triggers the [`./hooks/post-receive`](./hooks/post-receive) hook (see also `man githooks`).
- The `post-receive` hook builds a container image from your app source code, automatically detecting the language and creating a fairly optimized build (thanks to Buildpacks).
- Then the hook continues to start/restart containers that have changed.
- The included Traefik reverse proxy automatically requests a valid TLS certificate from Let's Encrypt, using the HTTP-01 challenge.
## Backup
You can use `rsync` to copy the entire `./data` directory to another server or your local machine, and you should be good to go.
You should also create a cron job on your server to perform this task periodically.
If your data is not too important and you don't need an offsite backup, using your cloud provider's disk snapshot feature is a viable option too.
## FAQ
**What's the catch?**
If you need advanced features such as high availability, more automation, or canary deployment, you'll need a bigger gun (e.g., Kubernetes).
**Where can I get a free domain?**
[duckdns.org](https://www.duckdns.org), [nip.io](https://nip.io), [sslip.io](https://sslip.io), etc.