SOFTWARE on PIGSTY

Enterprise Self-Hosted Supabase

Mon, 01 Jan 0001 00:00:00 +0000

Supabase is great, but having your own Supabase is even better. Pigsty can help you deploy enterprise-grade Supabase on your own servers (physical, virtual, or cloud) with a single command — more extensions, better performance, deeper control, and more cost-effective.

Pigsty is one of three self-hosting approaches listed on the Supabase official documentation: Self-hosting: Third-Party Guides

This tutorial requires basic Linux knowledge. Otherwise, consider using Supabase cloud or plain Docker Compose self-hosting.

Odoo: Self-Hosted Open Source ERP

Sun, 23 Jun 2024 00:00:00 +0000

Odoo is an open-source enterprise resource planning (ERP) software that provides a full suite of business applications, including CRM, sales, purchasing, inventory, production, accounting, and other management functions. Odoo is a typical web application that uses PostgreSQL as its underlying database.

All your business on one platform — Simple, efficient, yet affordable

Public Demo (may not always be available): http://odoo.pigsty.io, username: test@pigsty.io, password: pigsty

Quick Start

On a fresh Linux x86/ARM server running a compatible operating system:

Dify: AI Workflow Platform

Sun, 23 Jun 2024 00:00:00 +0000

Dify is a Generative AI Application Innovation Engine and open-source LLM application development platform. It provides capabilities from Agent building to AI workflow orchestration, RAG retrieval, and model management, helping users easily build and operate generative AI native applications.

Pigsty provides support for self-hosted Dify, allowing you to deploy Dify with a single command while storing critical state in externally managed PostgreSQL. You can use pgvector as a vector database in the same PostgreSQL instance, further simplifying deployment.

Teable: AI No-Code Database

Mon, 01 Jan 0001 00:00:00 +0000

Teable is a no-code database platform for team collaboration.

Pigsty v4.3 provides the app/teable template (conf/app/teable.yml) and depends on PostgreSQL + MinIO + Docker by default (no Redis dependency).

Quick Start

curl -fsSL https://repo.pigsty.io/get | bash; cd ~/pigsty
./bootstrap
./configure -c app/teable
vi pigsty.yml # update passwords, domain, and mail settings
./deploy.yml # deploy infra, PostgreSQL, and MinIO
./docker.yml
./app.yml

Default endpoints:

http://<IP>:8890
http://tea.pigsty

Key Settings

The template writes the following into /opt/teable/.env:

POSTGRES_HOST/POSTGRES_PORT/POSTGRES_DB/POSTGRES_USER/POSTGRES_PASSWORD
PRISMA_DATABASE_URL
PUBLIC_ORIGIN (public URL)
PUBLIC_DATABASE_PROXY
TEABLE_PORT (default 8890)

Operations

cd /opt/teable
make up
make log
make down

References

Teable docs: https://help.teable.io/
Pigsty template: https://github.com/pgsty/pigsty/blob/main/conf/app/teable.yml

Gitea: Self-Hosted Git Service

Wed, 25 May 2022 00:00:00 +0000

Gitea is a lightweight open-source Git hosting platform.

Pigsty’s app/gitea template uses external PostgreSQL mode by default, configured via GITEA_DB_* values in .env.

Quick Start

cd ~/pigsty/app/gitea
vi .env # check domain, ports, database settings
make up

Default endpoints:

Web: http://git.pigsty or http://<IP>:8889
SSH: <IP>:2222

Database Preparation

bin/pgsql-user pg-meta dbuser_gitea
bin/pgsql-db pg-meta gitea

Connection string example:

postgres://dbuser_gitea:DBUser.Gitea@10.10.10.10:5432/gitea

Common Commands

make up
make log
make stop
make clean

References

Gitea docs: https://docs.gitea.com/
Pigsty template: https://github.com/pgsty/pigsty/tree/main/app/gitea

NocoDB: Open-Source Airtable

Mon, 01 Jan 0001 00:00:00 +0000

NocoDB is an open-source Airtable alternative that turns any database into a smart spreadsheet.

It provides a rich user interface that allows you to create powerful database applications without writing code. NocoDB supports PostgreSQL, MySQL, SQL Server, and more, making it ideal for building internal tools and data management systems.

Quick Start

Pigsty provides a Docker Compose configuration file for NocoDB in the software template directory:

cd ~/pigsty/app/nocodb

Review and modify the .env configuration file (adjust database connections as needed).

Mattermost: Open-Source Team Collaboration

Mon, 01 Jan 0001 00:00:00 +0000

Mattermost is an open-source team collaboration platform and a private alternative to Slack.

Pigsty v4.3 provides app/mattermost (conf/app/mattermost.yml), which stores app state in external PostgreSQL and persists file directories on host paths.

Quick Start

curl -fsSL https://repo.pigsty.io/get | bash; cd ~/pigsty
./bootstrap
./configure -c app/mattermost
vi pigsty.yml # update passwords and domain
./deploy.yml
./docker.yml
./app.yml

Default endpoints:

http://<IP>:8065
http://mm.pigsty

On first access, initialize the admin account in the web UI.

Default Storage and Connections

Default template settings include:

Wiki.js: OSS Wiki Software

Wed, 25 May 2022 00:00:00 +0000

Public Demo: http://wiki.pigsty.cc

TL; DR

cd app/wiki ; docker-compose up -d

Postgres Preparation

# postgres://dbuser_wiki:DBUser.Wiki@10.10.10.10:5432/wiki
- { name: wiki, owner: dbuser_wiki, revokeconn: true , comment: wiki the api gateway database }
- { name: dbuser_wiki, password: DBUser.Wiki , pgbouncer: true , roles: [ dbrole_admin ] }

bin/pgsql-user pg-meta dbuser_wiki
bin/pgsql-db pg-meta wiki

Configuration

version: "3"
services:
 wiki:
 container_name: wiki
 image: requarks/wiki:2
 environment:
 DB_TYPE: postgres
 DB_HOST: 10.10.10.10
 DB_PORT: 5432
 DB_USER: dbuser_wiki
 DB_PASS: DBUser.Wiki
 DB_NAME: wiki
 restart: unless-stopped
 ports:
 - "9002:3000"

Access

Default Port for wiki: 9002

# add to nginx_upstream
- { name: wiki , domain: wiki.pigsty.cc , endpoint: "127.0.0.1:9002" }

./infra.yml -t nginx_config
ansible all -b -a 'nginx -s reload'

Maybe: Personal Finance

Mon, 01 Jan 0001 00:00:00 +0000

Maybe is an open-source personal finance manager.

Pigsty v4.3 provides the app/maybe template (conf/app/maybe.yml) to run Maybe as stateless containers while storing business data in external PostgreSQL.

Quick Start

curl -fsSL https://repo.pigsty.io/get | bash; cd ~/pigsty
./bootstrap
./configure -c app/maybe
vi pigsty.yml # must update SECRET_KEY_BASE, DB password, domain
./deploy.yml
./docker.yml
./app.yml

Default endpoints:

http://<IP>:5002
http://maybe.pigsty

Key Settings

In apps.maybe.conf, pay attention to:

SECRET_KEY_BASE: must be replaced with a random secret (e.g. openssl rand -hex 64)
DB_HOST/DB_PORT/DB_USERNAME/DB_PASSWORD/DB_DATABASE
APP_DOMAIN and MAYBE_PORT

Operations

app/maybe/Makefile runs in /opt/maybe by default:

Kong: API Gateway

Sat, 21 May 2022 00:00:00 +0000

Kong is an open-source API gateway.

Pigsty’s app/kong template stores configuration in PostgreSQL and runs a one-time migration job (kong-migration) automatically.

Quick Start

cd ~/pigsty/app/kong
vi .env # check KONG_PG_* and port settings
make

Default ports:

Proxy HTTP: 8000
Proxy HTTPS: 8443
Admin API: 8001

Database Preparation

bin/pgsql-user pg-meta dbuser_kong
bin/pgsql-db pg-meta kong

Connection string example:

postgres://dbuser_kong:DBUser.Kong@10.10.10.10:5432/kong

Common Commands

make log
make stop
make clean
make pull

References

Kong docs: https://docs.konghq.com/
Pigsty template: https://github.com/pgsty/pigsty/tree/main/app/kong

Metabase: BI Analytics Tool

Mon, 01 Jan 0001 00:00:00 +0000

Metabase is a fast, easy-to-use open-source business intelligence tool that lets your team explore and visualize data without SQL knowledge.

Metabase provides a friendly user interface with rich chart types and supports connecting to various databases, making it an ideal choice for enterprise data analysis.

Quick Start

Pigsty provides a Docker Compose configuration file for Metabase in the software template directory:

cd ~/pigsty/app/metabase

Review and modify the .env configuration file:

Registry: Container Image Cache

Mon, 01 Jan 0001 00:00:00 +0000

Pigsty v4.3 provides the app/registry template (conf/app/registry.yml) for:

Docker Registry cache service (default 5000)
Optional management UI (default 5080)

Quick Start

curl -fsSL https://repo.pigsty.io/get | bash; cd ~/pigsty
./bootstrap
./configure -c app/registry
vi pigsty.yml # update domains, certs, and ports if needed
./deploy.yml
./docker.yml
./app.yml

Default endpoints:

Registry API: http://<IP>:5000 or http://d.pigsty
Registry UI: http://<IP>:5080 or http://dui.pigsty

Image data is stored in /data/registry by default.

Docker Client Configuration

If you run HTTP without TLS, Docker must trust the registry explicitly:

ByteBase: Schema Migration

Fri, 20 May 2022 00:00:00 +0000

Bytebase is a database schema change and version management tool.

Pigsty provides a ready-to-use Compose template in app/bytebase. It listens on 8887 by default and connects to external PostgreSQL via BB_PGURL.

Quick Start

cd ~/pigsty/app/bytebase
vi .env # check BB_PORT / BB_DOMAIN / BB_PGURL
make up

Access:

http://ddl.pigsty
http://<IP>:8887

After first startup, initialize the admin account using the Bytebase setup wizard.

External PostgreSQL

Default connection string example:

postgresql://dbuser_bytebase:DBUser.Bytebase@10.10.10.10:5432/bytebase?sslmode=prefer

You can create the database user and database in Pigsty first:

PostgREST: Auto-Generated API

Sat, 21 May 2022 00:00:00 +0000

PostgREST exposes PostgreSQL schemas directly as REST APIs.

Pigsty provides the app/postgrest template, with default port 8884.

Quick Start

cd ~/pigsty/app/postgrest
vi .env # check DB_URI / DB_SCHEMA / JWT
make up

Default endpoints:

http://<IP>:8884
http://api.pigsty (if ingress domain is configured)

Key Settings

Common .env parameters:

POSTGREST_DB_URI: database connection string
POSTGREST_DB_SCHEMA: exposed schema (default pigsty)
POSTGREST_DB_ANON_ROLE: anonymous role
POSTGREST_JWT_SECRET: JWT secret

Swagger UI (Optional)

You can run Swagger UI separately to preview APIs:

PGAdmin4: PG Admin GUI Tool

Mon, 25 Apr 2022 00:00:00 +0000

pgAdmin4 is a useful PostgreSQL management tool. Execute the following command to launch the pgadmin service on the admin node:

cd ~/pigsty/app/pgadmin ; docker-compose up -d

The default port for pgadmin is 8885, and you can access it through the following address:

http://adm.pigsty

Demo

Public Demo: http://adm.pigsty.cc

Credentials: admin@pigsty.cc / pigsty

TL; DR

cd ~/pigsty/app/pgadmin # enter docker compose dir
make up # launch pgadmin container
make conf view # load pigsty server list

Shortcuts:

PGWeb: Browser-based PG Client

Fri, 18 Mar 2022 00:00:00 +0000

PGWEB: https://github.com/sosedoff/pgweb

Simple web-based and cross-platform PostgreSQL database explorer.

Public Demo: http://cli.pigsty.cc

TL; DR

cd ~/pigsty/app/pgweb ; make up

Visit http://cli.pigsty or http://10.10.10.10:8886

Try connecting with example URLs:

postgres://dbuser_meta:DBUser.Meta@10.10.10.10:5432/meta?sslmode=disable
postgres://test:test@10.10.10.11:5432/test?sslmode=disable

make up # pull up pgweb with docker compose
make run # launch pgweb with docker
make view # print pgweb access point
make log # tail -f pgweb logs
make info # introspect pgweb with jq
make stop # stop pgweb container
make clean # remove pgweb container
make pull # pull latest pgweb image
make rmi # remove pgweb image
make save # save pgweb image to /tmp/docker/pgweb.tgz
make load # load pgweb image from /tmp/docker/pgweb.tgz

Electric: PostgreSQL Sync Engine

Mon, 01 Jan 0001 00:00:00 +0000

Electric is a PostgreSQL sync engine focused on efficiently delivering database changes to frontend and edge applications.

Pigsty v4.3 provides the app/electric template (conf/app/electric.yml) to bootstrap database, container, and ingress settings in one flow.

Quick Start

curl -fsSL https://repo.pigsty.io/get | bash; cd ~/pigsty
./bootstrap
./configure -c app/electric
vi pigsty.yml # update domain, passwords, secrets
./deploy.yml
./docker.yml
./app.yml

Default endpoints:

http://<IP>:8002
http://elec.pigsty (default domain in the template)

Metrics port defaults to 8003 (ELECTRIC_PROMETHEUS_PORT).

Key Settings

conf/app/electric.yml writes apps.electric.conf into /opt/electric/.env. Common parameters:

Jupyter: AI Notebook & IDE

Mon, 01 Jan 0001 00:00:00 +0000

Run jupyter notebook with docker, you have to:

1. change the default password in .env: JUPYTER_TOKEN
1. create data dir with proper permission: make dir, owned by 1000:100
1. make up to pull up jupyter with docker compose

cd ~/pigsty/app/jupyter ; make dir up

Visit http://lab.pigsty or http://10.10.10.10:8888, the default password is pigsty

http://lab.pigsty?token=pigsty

Prepare

Create a data directory /data/jupyter, with the default uid & gid 1000:100:

make dir # mkdir -p /data/jupyter; chown -R 1000:100 /data/jupyter

Connect to Postgres

Use the jupyter terminal to install psycopg2-binary & psycopg2 package.

Supabase

Sun, 23 Jun 2024 00:00:00 +0000

Supabase — Build in a weekend, Scale to millions

Supabase is an open-source Firebase alternative that wraps PostgreSQL and provides authentication, out-of-the-box APIs, edge functions, real-time subscriptions, object storage, and vector embedding capabilities. This is a low-code all-in-one backend platform that lets you skip most backend development work, requiring only database design and frontend knowledge to quickly ship products!

Supabase’s motto is: “Build in a weekend, Scale to millions”. Indeed, Supabase is extremely cost-effective at small to micro scales (4c8g), like a cyber bodhisattva. — But when you really scale to millions of users — you should seriously consider self-hosting Supabase — whether for functionality, performance, or cost considerations.