Added OpenAudible

apps/openaudible/metadata/description.md

@@ -0,0 +1,91 @@
+# OpenAudible for Docker
+
+This container runs [OpenAudible](https://openaudible.org) with its GUI accessible by browser. 
+
+This is an experimental alternative to the supported and recommended desktop binaries available at [openaudible.org](https://openaudible.org). 
+
+This project is hosted on [github](https://github.com/openaudible/openaudible_docker) and [dockerhub](https://hub.docker.com/r/openaudible/openaudible)
+
+This project is based on the excellent [https://www.kasmweb.com/kasmvnc](https://www.kasmweb.com/kasmvnc) remote desktop container.
+
+## Description
+
+OpenAudible runs on Linux, Mac, and Windows. This Docker container runs the latest linux version
+in a container running Ubuntu that is via web browser. 
+
+This allows you to run OpenAudible from a container, on the cloud, or from any Docker capable system (NAS system?).
+
+No passwords are needed to access the web page, but a password can be added by modifying the "run.sh" file. 
+
+For personal use. Only one user can
+view web sessions at one time-so this can't be used to share the application with multiple viewers at the same time.
+
+
+You may want to map the volume /root/openaudible to access downloaded and converted audiobooks.
+
+## Quick Start
+
+```
+docker run -d --rm -it -p 3000:3000 --security-opt seccomp=unconfined --name openaudible openaudible/openaudible:latest
+```
+
+Then open your web browser to http://localhost:3000
+
+You'll probably want to access the volume where OpenAudible saves books.
+
+## Building and running from source
+```
+git clone https://github.com/openaudible/openaudible_docker.git 
+cd openaudible_docker
+./run.sh
+```
+
+The [run.sh](run.sh) file builds and runs the docker image. You may want to modify it to expose the OPENAUDIBLE volume. 
+Note: The latest version requires the docker run to include --security-opt seccomp=unconfined in the arguments. Without that, you would need to start OpenAudible manually, which can be done via:
+```
+./bash.sh
+su abc
+OpenAudible
+```
+
+If successful, the application will be up and running on port 3000 and
+accessible via http://localhost:3000 in a browser.
+
+The -rm flag removes the container when it quits. Any downloaded or converted books will be in the docker Volume.
+## Upgrade the Application
+To upgrade, you'll need to stop and delete (rm) the container, then restart using the same command you used to start it.
+Then when you launch the web page http://localhost:3000 the latest version will be downloaded and installed.
+
+```
+docker stop openaudible 
+docker rm openaudible
+docker run -d --rm -it -p 3000:3000 --security-opt seccomp=unconfined --name openaudible openaudible/openaudible:latest
+```
+
+Alternately, you can download and run the OpenAudible installer and not update the web linux environment:
+```
+curl -OL https://openaudible.org/latest/OpenAudible_x86_64.sh
+chmod +x OpenAudible_x86_64.sh
+./OpenAudible_x86_64.sh
+# If successful, delete installer file:
+rm ./OpenAudible_x86_64.sh
+```
+
+
+## Known limitations:
+* Another user logging on to the web page disconnects anyone else already connected
+* No password protection is offered or https proxy-but can be added. 
+* But it does allow a user to try the software in a containerized, accessible-from-anywhere way.
+
+## TODO items
+* Document how to access the "config" volume so you can access any converted books from the host machine.
+
+## Notes
+* This is experimental and unsupported. We hope some people find it useful. 
+* If you find any issues, please report them on [github.com/openaudible/openaudible_docker/issues](https://github.com/openaudible/openaudible_docker/issues).
+* Before deleting the container and volume, if you logged into Audible, you should Log out using the Control Menu, which will delete your virtual device.
+* Would appreciate feedback or pull requests. 
+* Docker is great for testing something, but we still recommend the desktop app for most users.
+
+## License
+The OpenAudible desktop application is free to try shareware.