Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation for adding custom backend functionality #466

Closed
sunjay opened this issue May 20, 2016 · 1 comment
Closed

Documentation for adding custom backend functionality #466

sunjay opened this issue May 20, 2016 · 1 comment

Comments

@sunjay
Copy link

sunjay commented May 20, 2016

The docs specify that Horizon can be extended to add custom backend functionality:

Horizon exposes a powerful API that allows writing sophisticated realtime applications. However, we carefully designed Horizon to provide an upgrade path in case your application outgrows the Horizon API. If you need to add backend functionality, instead of using the standalone Horizon server you can require Horizon in Node.js as a library, and mix and match Horizon services along with the rest of the Node.js ecosystem. Since Horizon is built on top of RethinkDB, your app will have full access to the underlying database, and you can write arbitrarily complex code without being limited by Horizon’s base APIs and tools.

However I haven't been able to find any documentation about how to do any of that. Can something about this be added?

My use case is some rules that need to be enforced (and hidden). I can't manage with simple validation functions. I want to add a custom endpoint on the backend (or something of that nature) to run my code. How would this look with horizon? Would this be a custom endpoint or would I be adding a method to the horizon object? The docs would hopefully answer these questions.

@danielmewes
Copy link
Member

Thanks for the feedback @sunjay.

@Tryneus can give you some pointers about where to put custom endpoints.
This comment by him might also be useful: #337 (comment)

Meanwhile, I opened rethinkdb/horizon-docs#62 about adding documentation for this.

(closing the issue since the remaining work is going to happen in horizon-docs)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants