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 updates and details #1

Open
onixterry opened this issue Sep 19, 2017 · 1 comment
Open

Documentation updates and details #1

onixterry opened this issue Sep 19, 2017 · 1 comment
Assignees

Comments

@onixterry
Copy link

It would be great if the README file contained some information on how to run the application and under the situations in which it is designed to be used.

For example, it appears that the application is meant to be run from the Solr server itself given that you must input the path to the Solr install. A typical use case would be that you are running this application from another machine rather than directly on it. If that is not supported, and there is no way to use it that way, it would be good to point that out as a limitation. In my case, I typically have my Solr servers on Linux VM and SSH into them from a Windows workstation. It does not appear that I could use the tool in that manner.

Second, there does not appear to be any documentation on how to run it. I had to copy place the "current" SolrAuthManager.jar into a folder and then copy the "lib" folder from the project so that it was in the same folder as SolrAuthManager.jar. This allowed the application to run. I would note the details on this in the instructions. If there is a simple way to build the application (I tried BUILD in IntelliJ and it did not create the dist and dist/lib folders that I believe it should have.

Seems like a very useful tool, hoping to get to use it.

@kmcowan
Copy link
Owner

kmcowan commented Aug 8, 2018

Hey Terry,
Thanks for the comment. I will work on getting you some further documentation! At this point, it is a command line tool. The web interface is under construction. I appreciate your feedback, though, and will work to add that to the project. Sorry for the long delay in response!

@kmcowan kmcowan self-assigned this Aug 8, 2018
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