Skip to content

pentacent/keila

Repository files navigation

GitHub Workflow Status (branch) Docker Image Version (latest semver) GitHub release (latest SemVer) GitHub Sponsors

The Keila logo is a stylized elephant Keila - An Open Source Newsletter Tool

Keila is an Open Source alternative to newsletter tools like Mailchimp or Sendinblue.

With Keila you can easily send out newsletter campaigns and create sign-up forms.

For smaller newsletters, you can use your own email inbox to send out campaigns. For larger newsletter projects, AWS SES, Sendgrid, and Mailgun are supported in addition to SMTP.

Screenshot of the Keila campaign editor showing the WYSIWYG editor and the default template

Giving Keila a Try

You can give a hosted version of Keila a try at keila.io/try.

If you want to deploy Keila on your own server, you can use the official Docker image pentacent/keila or use the sample Docker Compose config in this repo.

Follow the Installation Docs for more details.

Developing Keila

If you want to give Keila a try, here’s how to get it running from this repository:

  • Install Elixir and make sure you have PostgreSQL running on your machine
  • Clone the repository: git clone https://github.com/pentacent/keila.git
  • Install dependencies with mix deps.get
  • Install dependencies and set up the database with mix setup
  • Start Keila server with mix phx.server

Now you can visit localhost:4000 from your browser.

(Optional) Developing Keila inside a DevContainer

Here’s how to get it running using DevContainer from Visual Code:

  • Install Remote Container extension in Visual Code
  • Click on the bottom left corner with the icon below and choose Reopen in Container

Screenshot of DevContainer icon

  • Wait for the containers to build and install all the dependencies needed to run Keila, including PostgreSQL and Elixir
  • Open a terminal inside the container and proceed to run the commands from Developing Keila section

The Name

Keila is the name of the elephant mascot of this project. She’s a wise and diligent elephant lady, able to remember countless email addresses and contact names. Fun fact: Keila loves going on holiday trips to the lakes of Finland.

License

Keila is free software. You can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

For more details, please read the full license here.

Please note that the Keila logo is not subject to the aforementioned license.