https://github.com/getindiekit/example-config

Example configuration for Indiekit
https://github.com/getindiekit/example-config

indiekit indieweb

Last synced: 2 months ago
JSON representation

Example configuration for Indiekit

• Host: GitHub
• URL: https://github.com/getindiekit/example-config
• Owner: getindiekit
• License: mit
• Created: 2021-12-17T14:49:51.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-04-08T22:55:28.000Z (10 months ago)
• Last Synced: 2024-05-01T11:23:05.535Z (9 months ago)
• Topics: indiekit, indieweb
• Language: JavaScript
• Homepage: https://getindiekit.com/get-started
• Size: 463 KB
• Stars: 3
• Watchers: 0
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Example configuration for Indiekit

This example configuration can be used as a starting point for configuring your own Indiekit server.

This example assumes that want to:

* host your content on GitHub

* publish your website using Jekyll

* syndicate content to a Mastodon server

## Configuration variables

The following strings in the [configuration file](indiekit.config.js) should be replaced with your own values (or saved as environment variables):

* `process.env.PUBLICATION_URL`

* `process.env.GITHUB_USERNAME`

* `process.env.GITHUB_REPOSITORY`

* `process.env.GITHUB_BRANCH`

* `process.env.MASTODON_SERVER`

* `process.env.MASTODON_USERNAME`

Some values shouldn’t be made public, or included in your configuration file. Instead, they should be saved as environment variables that can only be seen by you and your server:

* `GITHUB_TOKEN`

* `MASTODON_ACCESS_TOKEN`

* `MONGO_URL`

* `PASSWORD_SECRET`

* `SECRET`

## Starting your server

Once you have updated the configuration file with your own values, and ensured environment variables are present, you can start the server using the following command:

`npm start`

## Server deployment using Docker

If you want to deploy your server using [Docker](https://www.docker.com), the following files are provided as a starting point:

* `.dockerignore`

* `docker-compose.yml`

* `Dockerfile`

If you are using Docker Compose, the `MONGO_URL` environment variable does not need to be set. The following environment variables should be provided instead:

* `MONGO_INITDB_ROOT_USERNAME`

* `MONGO_INITDB_ROOT_PASSWORD`

## Server deployment using Railway

Click the button to use this configuration as the basis of a new service deployed with Railway:

[![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/template/gEboK6?referralCode=bCd1gL)