Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/artcom/acms-compose

ACMS is a basic, modular, JSON-based and headless CMS
https://github.com/artcom/acms-compose

Last synced: about 1 month ago
JSON representation

ACMS is a basic, modular, JSON-based and headless CMS

Host: GitHub
URL: https://github.com/artcom/acms-compose
Owner: artcom
Created: 2021-03-22T13:23:37.000Z (almost 4 years ago)
Default Branch: master
Last Pushed: 2024-03-03T12:02:51.000Z (11 months ago)
Last Synced: 2024-11-07T06:36:21.069Z (3 months ago)
Size: 263 KB
Stars: 2
Watchers: 11
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# ACMS Compose

ACMS is a simple, modular, headless CMS.

It is centered around JSON files which contain the content including asset links as well as templates defining the content structure. It is composed of four modules:

This repository provides [docker-compose](./docker-compose.yml) files to setup the ACMS. It orchestrates the services above in containers as well as an optional `gateway` to access them.

## Requirements

- [docker](https://www.digitalocean.com/community/tutorials/how-to-install-and-use-docker-on-ubuntu-22-04) (>= 24.0.6)
- [docker compose CLI plugin](https://www.digitalocean.com/community/tutorials/how-to-install-and-use-docker-compose-on-ubuntu-22-04) (>= 2.23.0)

## Install the ACMS UI web page

- download the UI static files inside the `acms-compose` folder
```bash
wget https://github.com/artcom/acms-ui/releases/download/v2.17.8/acms-ui-v2.17.8.tar.gz
mkdir ui
tar -xvzf acms-ui-v2.17.8.tar.gz -C ui
```
- edit the `ui/config.json` file
```json
{
"acmsAssetsUri": "https:///services/acms-assets",
"acmsApiUri": "https:///services/acms-api",
"acmsConfigPath": "acmsConfig"
}
```

## Start Services

### HTTP Gateway

- edit the `.env.http.example` file
- deploy with

```bash
docker compose --env-file .env.http.example -f docker-compose.yml -f docker-compose-gateway-http.yml up
```

- browse to the ACMS UI: `http://127.0.0.1`

### HTTPS Gateway

- create an [SSL certificate and key](https://letsencrypt.org/docs/certificates-for-localhost)

```bash
openssl req -x509 -out localhost.crt -keyout localhost.key \
-newkey rsa:2048 -nodes -sha256 \
-subj '/CN=localhost' -extensions EXT -config <( \
printf "[dn]\nCN=localhost\n[req]\ndistinguished_name = dn\n[EXT]\nsubjectAltName=DNS:localhost\nkeyUsage=digitalSignature\nextendedKeyUsage=serverAuth")
```

- create a `dhparam.pem` file
```bash
openssl dhparam -out dhparam.pem 2048
```
- update the `.env.https.example` file
- deploy with

```bash
docker compose --env-file .env.https.example -f docker-compose.yml -f docker-compose-gateway-https.yml up
```

- browse to the ACMS UI: `https://localhost`

### Basic Authentication

- create a `.htpasswd` file

```bash
htpasswd -c .htpasswd username
```

- edit the `AUTH_FILE` variable in `.env.https.example`
- deploy with

```bash
docker compose --env-file .env.https.example -f docker-compose.yml -f docker-compose-gateway.yml -f docker-compose-gateway-basic-auth.yml up
```

## CORS

- to support cross origin requests uncomment the `CORS` section in `gateway/nginx.conf`

## Edit Content

The content repository will be setup with some sample data. To modify the content structure you can clone the config repository:

if you're usting http
```bash
git clone http://localhost/services/acms-config
```

if you're using https
```bash
git clone https://localhost/services/acms-config
```

- Edit the template/content files according to the [documentation](https://github.com/artcom/acms-ui)
- Commit and push your changes
- Reload the ACMS UI

## Troubleshooting

- use the `--force-recreate` flag when any configurations in `gateway` have changed