Skip to content

delphi-hub/delphi-management

Repository files navigation

Delphi Management Console

A management console for the Delphi platform.

We are currently in pre-alpha state! There is no release and the code in this repository is purely experimental!

branch status codacy snyk
master Build Status Codacy Badge Known Vulnerabilities
develop Build Status Codacy Badge Known Vulnerabilities

What is the Delphi Management Console?

It is a web application to allow administrators to control the crawling process.

How does it work?

It takes commands from authenticated administrators over the web interface and issues the appropriate steps in the crawler.

How can I use it?

To build the angular app for deployment make sure to have npm and the angular cli installed

cd client && npm install && ng build --prod && cd ..

For OS X users you need to expose the TCP port manually. The docker FAQ suggest it in this way:

docker run -d -v /var/run/docker.sock:/var/run/docker.sock -p 127.0.0.1:9095:9095 bobrik/socat TCP-LISTEN:9095,fork UNIX-CONNECT:/var/run/docker.sock

For any deployed instance you need an administrator account to interact with the application. You can start your own instance by executing

sbt run

Community

Feel welcome to join our chatroom on Gitter: Join the chat at https://gitter.im/delphi-hub/delphi

Contributing

Contributions are very welcome!

Before contributing, please read our Code of Conduct.

Refer to the Contribution Guide for details about the workflow. We use Pull Requests to collect contributions. Especially look out for "help wanted" issues GitHub issues by-label, but feel free to work on other issues as well. You can ask for clarification in the issues directly, or use our Gitter chat for a more interactive experience.

GitHub issues

License

The Delphi CLI is open source and available under Apache 2 License.

GitHub license