Bombabillo is a non-web client for the terminal, supporting Gopher, Gemini and much more. https://bombadillo.colorfield.space
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

139 lines
7.9 KiB

1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
  1. # Bombadillo - a non-web browser
  2. Bombadillo is a non-web browser for the terminal.
  3. ![a screenshot of the bombadillo browser](bombadillo-screenshot.png)
  4. Bombadillo features a full terminal user interface, vim-like keybindings, document pager, configurable settings, and a robust command selection.
  5. Currently, Bombadillo supports the following protocols as first class citizens:
  6. * gopher
  7. * gemini
  8. * finger
  9. * local (a user's file system)
  10. Support for the following protocols is also available via integration with 3rd party applications:
  11. * telnet
  12. * Links are opened in a telnet application run as a subprocess.
  13. * http/https
  14. * Web support is opt-in (turned off by default).
  15. * Links can be opened in a user's default web browser when in a graphical environment.
  16. * Web pages can be rendered directly in Bombadillo if [Lynx](https://lynx.invisible-island.net/), [w3m](http://w3m.sourceforge.net/), or [elinks](http://elinks.or.cz/) are installed on the system to handle the document parsing.
  17. ## Getting Started
  18. These instructions will get a copy of the project up and running on your local machine. The following only applies if you are building from source (rather than using a precompiled binary).
  19. ### Prerequisites
  20. You will need to have [Go](https://golang.org/) version >= 1.11.
  21. To use the Makefile you will need a make that is GNU Make compatible (sorry BSD folks)
  22. ### Building, Installing, Uninstalling
  23. Bombadillo installation uses `make`. It is also possible to use Go to build and install (i.e `go build`, `go install`), but this is not the recommended approach.
  24. Running `make` from the source code directory will build Bombadillo in the local directory. This is fine for testing or trying things out. For usage system-wide, and easy access to documentation, follow the installation instructions below.
  25. #### Basic Installation
  26. Most users will want to install using the following commands:
  27. ```shell
  28. git clone https://tildegit.org/sloum/bombadillo.git
  29. cd bombadillo
  30. sudo make install
  31. ```
  32. *Note: the usage of `sudo` here will be system dependent. Most systems will require it for installation to `/usr/local/bin`.*
  33. You can then start Bombadillo by running the command:
  34. ```shell
  35. bombadillo
  36. ```
  37. To familiarize yourself with the application, documentation is available by running the command:
  38. ```shell
  39. man bombadillo
  40. ```
  41. #### Custom Installation
  42. ##### Configuration Options
  43. There are a number of default configuration options in the file `defaults.go`, allowing customisation of the default settings for users of Bombadillo.
  44. To use this feature, amend the `defaults.go` file as appropriate, then follow the standard install instructions.
  45. Full documentation for these options is contained within the `defaults.go` file.
  46. An administrator might use this to feature to set a default for all users of a system. Typically though, these options should not need changing, and a user may change most of these settings themselves once they start Bombadillo. The one option that can only be configured in `defaults.go` is `configlocation` which controls where `.bombadillo.ini` is stored.
  47. ##### Override Install Location
  48. The installation location can be overridden at compile time, which can be very useful for administrators wanting to set up Bombadillo on a multi-user machine.
  49. ```shell
  50. git clone https://tildegit.org/sloum/bombadillo.git
  51. cd bombadillo
  52. sudo make install PREFIX=/some/directory
  53. ```
  54. There are two things to know about when using the above format:
  55. 1. The above would install Bombadillo to `/some/directory/bin`, _not_ to `/some/directory`. So you will want to make sure your `$PATH` is set accordingly.
  56. 2. Using the above will install the man page to `/some/directory/share/man/man1`, rather than its usual location. You will want to update your `manpath` accordingly.
  57. There are other overrides available - please review the [Makefile](Makefile) for more information.
  58. #### Uninstall
  59. If you used the Makefile to install Bombadillo then uninstalling is very simple. From the Bombadillo source folder run:
  60. ```shell
  61. sudo make uninstall
  62. ```
  63. If you used a custom `PREFIX` value during install, you will need to supply it when uninstalling:
  64. ```shell
  65. sudo make uninstall PREFIX=/some/directory
  66. ```
  67. Uninstall will clean up any build files, remove the installed binary, and remove the man page from the system. It will _not_ remove any directories created as a part of the installation, nor will it remove any Bombadillo user configuration files.
  68. #### Troubleshooting
  69. If you run `bombadillo` and get `bombadillo: command not found`, try running `make` from within the cloned repo. Then try: `./bombadillo`. If that works it means that the application is getting built correctly and the issue is likely in your path settings. Any errors during `make install` should be visible, and you will be able to see what command it failed on.
  70. ### Downloading
  71. If you would prefer to download a binary for your system, rather than build from source, please visit the [Bombadillo releases](http://bombadillo.colorfield.space/releases) page. Don't see your OS/architecture? Bombadillo can be built for use with any system that is supported as a target for the Go compiler (Linux, BSD, OS X, Plan 9). There is no explicit support for, or testing done for, Windows or Plan 9. The program should build on those systems, but you may encounter unexpected behaviors or incompatibilities.
  72. ### Documentation
  73. Bombadillo's primary documentation can be found in the man entry that installs with Bombadillo. To access it run `man bombadillo` after first installing Bombadillo. If for some reason that does not work, the document can be accessed directly from the source folder with `man ./bombadillo.1`.
  74. In addition to the man page, users can get information on Bombadillo on the web @ [http://bombadillo.colorfield.space](http://bombadillo.colorfield.space). Running the command `help` inside Bombadillo will navigate a user to the gopher server hosted at [bombadillo.colorfield.space](gopher://bombadillo.colorfield.space); specifically the user guide.
  75. ## Contributing
  76. Bombadillo development is largely handled by Sloum, with help from asdf, jboverf, and community input.
  77. There are many ways to contribute to Bombadillo, including a fair few that don't require knowledge of programming:
  78. - Try out the browser and let us know if you have a suggestion for improvement, or if you find a bug.
  79. - Read the documentation and let us know if something isn't well explained, or needs correction.
  80. - Maybe you have a cool logo or some art that you think would look nice.
  81. If you have something in mind, please reach out or [open an issue](https://tildegit.org/sloum/bombadillo/issues).
  82. We aim for simplicity and quality, and do our best to make Bombadillo useful to its users. Any proposals for change are reviewed by the maintainers with this in mind, and not every request will be accepted. Furthermore, this software is developed in our spare time for the good of all, and help is provided as best efforts. In general, we want to help!
  83. The maintainers use the [tildegit](https://tildegit.org) issues system to discuss new features, track bugs, and communicate with users regarding issues and suggestions. Pull requests should typically have an associated issue, and should target the `develop` branch.
  84. ## Development
  85. See [DEVELOPING.md](DEVELOPING.md) for information on how changes to Bombadillo are made, along with other technical information for developers.
  86. ## License
  87. This project is licensed under the GNU GPL version 3. See the [LICENSE](LICENSE) file for details.
  88. ## Releases
  89. Starting with version 2.0.0 releases into `master` will be version-tagged. Work done toward the next release will be created on work branches named for what they are doing and then merged into `develop` to be combined with other ongoing efforts before a release is merged into `master`. At present there is no specific release schedule. It will depend on the urgency of the work that makes its way into develop and will be up to the project maintainers' judgement when to release from `develop`.