Giter VIP home page Giter VIP logo

ghosthook's Introduction

ghosthook

Attention

This project is no longer actively maintained because the blog which caused the whole project went down. PRs are still accepted but there is no reason to actively work on this.

What is ghosthook?

I created ghosthook to serve as an adapter between the Ghost blogging platform and various other platforms (first and foremost Discord).
Feel free to open a issue or PR to add support for more.

Setup

It's pretty straight forward: Either download the precompiled binary from the releases page or get the sourcecode and compile it yourself.

  1. Create a config.toml with all the config parameters shown below.
  2. Create a new custom ghost integration the the admin dashboard and to point the url to http://<host_uri>/post/published.
  3. Try to start the adapter and publish a test post to ensure everything is working as indented. If any errors occur, please open an issue.

Configuration

ghosthook uses a config file in the toml format. For the required and optional parameters, please see below.

config value use example default required?
host_uri Set the ip and port to bind to 127.0.01:2354 -/- yes
preview_length Set the amount of text that will be previewed
in the hook's message
150 -/- yes
webhook_username The name the app uses in its webhooks ghosthook -/- yes
webhook_avatar_url Set the avatar the webhooks uses https://example.com/ghosthook.png -/- yes
discord_webhooks This can hold an unlimited amount of credentials to discord webhooks [{id = 123, token = "tkn"}, {id = 321, token = "TOKEN"}] -/- yes

Available endpoints

Endpoint Use
/post/published Trigger the Post Published webhook message

Legal

This project is licensed under either the Apache License, Version 2.0 or MIT license at your option.
Unless you explicitly state otherwise, any contribution submitted by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

ghosthook's People

Contributors

oleggtro avatar

Watchers

 avatar

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.