Overview:
CouchDB LookoutWeb is an admin dashboard designed for CouchDB servers. It allows users to perform various operations and view databases, documents, revisions, and more. It comes with features like an ACE editor, query interface, and GitHub Pages integration.
Features:
- View Databases: Users can view the list of databases in their CouchDB server.
- View Docs: Users can view the documents stored in a specific database.
- Add/Delete Databases: Users have the ability to add or delete databases in their CouchDB server.
- Add/Delete/Edit Docs: Users can add, delete, or edit documents in a particular database.
- ACE Editor: The dashboard is equipped with an ACE editor, allowing users to edit documents with ease.
- Run Queries Interface: Users can execute queries and view query results directly from the dashboard.
- GitHub Pages: The dashboard can be deployed as a GitHub Pages site for easy access and hosting.
- View Revisions: Users can view the revision history of a document.
- Deploy as a Couch View to Remote Couch Script: A deploy script is available to attach the index.html & dist/lookout.js as attachments to a CouchDB view doc.
- Replication Wizard: An upcoming feature in the wishlist, it will provide a replication wizard for easier data replication.
- CouchDB View Query: Another requested feature in the wishlist, it aims to provide a view query functionality similar to the _find page.
- Server Config Editor: A wishlist item is to have a server config editor, but it is emphasized that it should be a safe one.
- Download Doc as JSON Buttons: A wishlist item is to have download buttons for individual documents and the all-docs view.
- Bulk Docs Interface: Another wishlist item, it envisions an interface that shows ACE editor diffs of the documents about to be changed in a bulk operation.
- Better ID Search with Doc Links: The current ID search functionality is limited to basic querying and a wishlist item is to improve it with document links.
Installation:
To run CouchDB LookoutWeb locally, follow these steps:
- Download the index.html & dist/lookout.js files.
- Attach these files as attachments to a CouchDB view doc.
- Edit the index file’s src= url to match your CouchDB server’s URL.
Summary:
CouchDB LookoutWeb is an admin dashboard for CouchDB servers that allows users to perform various admin tasks and view databases, documents, revisions, and more. It offers features like an ACE editor, query interface, and GitHub Pages integration. However, users are advised to exercise caution while using the tool as it has the potential to accidentally delete databases. It is recommended to test its functionality on a localhost server before using it in a production environment.