search

carlnewton / habitat

GNU Affero General Public License v3.0
21 stars 1 forks source link
decentralisation decentralised decentralization decentralized docker federated fediverse geolocation location location-based maps php self-hosted social-network social-platform symfony

readme

Habitat

This project is currently in very early development. For information on the purpose of Habitat, read the blog post.

Getting Started

Fork this repository to create your own instance of Habitat. To adhere to the AGPL license, your fork must be a public repository, so be careful not to ever commit any secrets to your fork.

Linux Server Hosting

The packages and setup required for hosting Habitat on a Linux server are in the Ansible playbook.

Install ansible and the collections:

ansible-galaxy collection install community.general
ansible-galaxy collection install community.mysql

To run the ansible playbook:

  1. Navigate to the Ansible directory
  2. Copy vars.yaml.template to vars.yaml and amend its contents accordingly
  3. Run ansible-playbook -i "domain-or-ip-address.example.com," -u example-user playbook.yaml --key-file=~/.ssh/example-key

Deploying the application

  1. Set the repository setting in App/deploy.php to your fork of Habitat
  2. Update the host entry in App/deploy.php accordingly
  3. Run vendor/bin/dep deploy
  4. Run vendor/bin/dep database:migrate

Docker Hosting

Habitat can be setup to run on a container hosting service (Such as Google Cloud Run).

When hosting Habitat using the Dockerfile container, you'll need to connect it to:

Continuous Deployment

Many container hosting services offer continous deployment so that any changes to your fork of the Habitat repository automatically get deployed.

To do so, ensure that the hosting service uses the following settings:

Setting Value
Branch main
Build type Dockerfile
Dockerfile location /Dockerfile

Configuration

Setting Value
Container port 80

Volumes

You'll need to attach a volume for image storage. If using cloud hosting, it's recommended to use a storage bucket, such as Google Cloud Storage or Amazon S3.

Setting Value
Mount path /var/www/uploads

Environment Variables

You'll need to set environment variables to allow the connection of a database and email handler. If using Google Cloud hosting, you can use the Google Cloud SQL service for the database, and if using AWS, you could use AWS RDS. For email handling, Mailjet have a free tier that should be enough for most Habitat isntances.

Name Value
DATABASE_URL mysql://dbUsername:dbPassword@localhost:3306/example-db-name?unix_socket=/cloudsql/example:database-instance:connection-name&serverVersion=8.0.31&charset=utf8mb4
MAILER_DSN smtp://example:example@example.com:587
APP_ENV prod
ENCRYPTION_KEY (Generate an encryption key*)

There are online key generators. It is recommended that the encryption key is no fewer than 32 characters, consists of uppercase, lowercase, numeric and special characters.

Local Development

  1. Navigate to the Docker/dev directory and copy the .env.dist file to create a new file called .env
  2. Run docker-compose up

Run any application, symfony and composer commands from within the habitat-apache-php container:

docker exec -it habitat-apache-php bash

Habitat can be loaded in the web browser from localhost.