Giter Site home page Giter Site logo

corysanin / seance Goto Github PK

View Code? Open in Web Editor NEW
6.0 1.0 0.0 186 KB

A self-hostable contact form for Ghost

License: GNU General Public License v3.0

Dockerfile 2.86% TypeScript 66.53% JavaScript 3.27% CSS 4.64% SCSS 11.44% EJS 11.26%
contact-form ghost ghost-blog bun

seance's Introduction

Seance for Ghost

GitHub Actions Workflow Status GitHub code size in bytes GitHub Release GitHub Release Date Docker Pulls GitHub License

Seance for Ghost

Self-hostable contact form service for Ghost blogs. Or any other applications you can think of. The limit is in your mind.

Add a contact form to your Ghost site without a subscription!

Seance embedded in a Ghost page

Install and run

bun install

To run:

bun run index.ts [path/to/config.json5]

A docker image corysanin/seance:master is provided. See docker-compose.yml.

Configuration

Seance takes a JSON or JSON5 config file (default location is config/config.json5):

{
    // The port the web server will run on (default 8080)
    "port": number,
    // Array of hosts allowed to embed the contact form. Default is to allow all (not recommended)
    allowedHosts: string[],
    // If using reCAPTCHA, provide the site key
    recaptchaKey: string,
    // If using reCAPTCHA, provide the site secret
    recaptchaSecret: string,
    // The Nodemailer transport configuration. See https://nodemailer.com/smtp/
    smtp: SMTPTransport | SMTPTransport.Options,
    // The address to send emails from. Defaults to the smtp username
    senderAddress: string,
    // The address to send emails to
    recipientAddress: string,
    // The subject prefix for all mail sent using this form. Default is "Form submission"
    subject: string,
}

Ghost Installation

Create a page for your contact form. Add an "Other" embed section. Enter your Seance instance's URL:

https://contact.example.com/?dark=false

If you're using a dark theme you can change the dark parameter to true. Note that the dark mode may look weird in the editor. It will look better on the live site.

seance's People

Contributors

corysanin avatar dependabot[bot] avatar

Stargazers

 avatar 5hiftly avatar Aaron Junod avatar Caleb Forestal |  avatar Evan Reid avatar Hong avatar

Watchers

 avatar

seance's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.