https://github.com/unagisoftware/paolog
Live web log viewer for rails apps
https://github.com/unagisoftware/paolog
Last synced: about 1 month ago
JSON representation
Live web log viewer for rails apps
- Host: GitHub
- URL: https://github.com/unagisoftware/paolog
- Owner: unagisoftware
- License: mit
- Created: 2020-05-21T14:56:40.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-05-21T15:21:35.000Z (about 6 years ago)
- Last Synced: 2025-02-28T00:16:12.423Z (over 1 year ago)
- Language: Ruby
- Size: 9.77 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: MIT-LICENSE
Awesome Lists containing this project
README
# Paolog (aka Paolo el loggero)
Paolog is a live web log viewer for Rails apps.
### Disclaimer
This project was based on [browserlog gem](https://travis-ci.org/dieb/browserlog). It was adapted to work with Rails 5.
## Installation
The simplest way to install Paolog is to use [Bundler](http://bundler.io).
```ruby
gem 'paolog'
```
Paolog is bundled as a Rails engine. Mount it on `config/routes.rb`.
```ruby
MyApp::Application.routes.draw do
mount Paolog::Engine => '/paolog'
end
```
With this setup ``logs/development``, ``logs/staging``, ``logs/production`` and ``logs/test`` are automatically available on the browser.
## Limit
By default, paolog with display your last 100 lines of your log. If you
want to see more lines you can use the `limit` parameter: `/paolog?limit=150`
## Note for production environments
For most production environments, it's recommended to not serve logs without authentication. This gem blocks by default any requests to ``logs/*`` in such production environment (i.e. ``RAILS_ENV=production``).
In case you want to allow those logs to be displayed under production (e.g. staging servers), use the following initializer:
```ruby
# config/initializers/allow_logs_on_production.rb
Paolog.config.allow_production_logs = true
```
## Authentication
The gem uses HTTP Basic Authentication method. In order to work you
should `user` and `password` in your encrypted credentials as follows:
```ruby
paolog:
user: paolo
password: elloggero
```
## Supported Rails Versions
* Rails >= 4