markdownr 0.5.8 → 0.5.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44c223ecfa0f81c35d2d3d89a5c316eb2adc7f0a343db241185dc828268d3527
-  data.tar.gz: 7b87a1fed84d540c89bc92bea8de754eee3d680ba93f952ad4b23c7150aa06b3
+  metadata.gz: afce137b9a88a74b444125a02f30a12dba75210bd3e223052542bea4ea39d4bf
+  data.tar.gz: b2cebe87af19b5f2ec26270b6f5b79d05472357e3dcb6916b9047ca69a27a3d5
 SHA512:
-  metadata.gz: 8eb259d062a13af47d3126ea380777e01aba1f1e6bc9401fb2f05c8277e9a827d6e16f9299e96768236574114875c0f4d2b5ab273094513c71670afa765f3e12
-  data.tar.gz: 56fda7d165fecbec5b46d8a496d257aa38164684779225bfac6e1d9da00df3fb8da3e90fbd4c58c435f2680a21869271f06c4b3791df48b9ac1b6d64e7359277
+  metadata.gz: 94c9857b53bad2ac793ae931607ee74e06f02f2410a029a0cfd5568754daa4befd6d913257ec9fbb673c594b1701ce4a9ef7e2f7681dba7c16f0406e6a8886ea
+  data.tar.gz: b55430f749eadd254de9b2feffd9d9aef09566166d47f33d42be29c58d826955d42a47f7c2fb704ccc807e0748e3b1bfcb7a245c558a38d014acabef2d3894c9

data/bin/Dockerfile.markdownr

@@ -0,0 +1,5 @@
+FROM ruby:3.4-slim
+RUN apt-get update && apt-get install -y build-essential && gem install markdownr
+WORKDIR /data
+CMD ["markdownr", "--behind-proxy", "-b", "0.0.0.0", "/data"]
+

data/bin/markdownr

@@ -23,6 +23,14 @@ OptionParser.new do |opts|
     options[:allow_robots] = true
   end
 
+  opts.on("--behind-proxy", "Trust X-Forwarded-For for client IP (use when behind a reverse proxy like Caddy)") do
+    options[:behind_proxy] = true
+  end
+
+  opts.on("-i", "--index-file FILENAME", "Render this file instead of the directory listing when present (e.g. index.md, moc.md)") do |f|
+    options[:index_file] = f
+  end
+
   opts.on("--no-link-tooltips", "Disable preview tooltips for local markdown links") do
     options[:link_tooltips] = false
   end
@@ -46,8 +54,10 @@ unless File.directory?(dir)
 end
 
 MarkdownServer::App.set :root_dir, dir
+MarkdownServer::App.set :behind_proxy, options[:behind_proxy] || false
 MarkdownServer::App.set :custom_title, options[:title]
 MarkdownServer::App.set :allow_robots, options[:allow_robots] || false
+MarkdownServer::App.set :index_file, options[:index_file]
 MarkdownServer::App.set :link_tooltips, options.fetch(:link_tooltips, true)
 MarkdownServer::App.set :hard_wrap, options.fetch(:hard_wrap, true)
 MarkdownServer::App.set :port, options[:port]

data/bin/push-to-docker

@@ -0,0 +1,12 @@
+#!/bin/bash
+set -e
+
+IMAGE="$DOCKER_HUB_USERNAME/markdownr:latest"
+
+echo "$DOCKER_HUB_TOKEN" | docker login -u "$DOCKER_HUB_USERNAME" --password-stdin
+
+docker build --no-cache -f bin/Dockerfile.markdownr -t "$IMAGE" .
+
+docker push "$IMAGE"
+
+docker logout

data/lib/markdown_server/app.rb

@@ -9,6 +9,7 @@ require "cgi"
 require "pathname"
 require "set"
 require "net/http"
+require "base64"
 
 module MarkdownServer
   class App < Sinatra::Base
@@ -20,11 +21,15 @@ module MarkdownServer
       set :root_dir, Dir.pwd
       set :custom_title, nil
       set :allow_robots, false
+      set :index_file, nil
       set :link_tooltips, true
       set :hard_wrap, true
       set :show_exceptions, false
       set :protection, false
       set :host_authorization, { permitted_hosts: [] }
+      set :behind_proxy, false
+      set :session_secret, ENV.fetch("MARKDOWNR_SESSION_SECRET", SecureRandom.hex(64))
+      set :sessions, key: "markdownr_session", same_site: :strict, httponly: true
     end
 
     helpers do
@@ -636,8 +641,10 @@ module MarkdownServer
           inflections.sort_by! { |i| -i[:freq] }
           if inflections.any?
             rows = inflections.map { |i|
-              link = i[:href] ? %(<a href="#{h(i[:href])}" target="_blank" rel="noopener">#{h(i[:word])}</a>) : h(i[:word])
-              %(<tr><td>#{link}</td><td class="blb-right">#{i[:freq]}x</td></tr>)
+              match = i[:word] == word
+              cls   = match ? ' class="blb-match"' : ""
+              link  = i[:href] ? %(<a href="#{h(i[:href])}" target="_blank" rel="noopener">#{h(i[:word])}</a>) : h(i[:word])
+              %(<tr><td#{cls}>#{link}</td><td class="blb-right">#{i[:freq]}x</td></tr>)
             }.join
             infl_html = %(<h4 class="blb-heading">Inflections</h4>) +
               %(<table class="blb-table"><thead><tr><th class="blb-th">Form</th>) +
@@ -727,6 +734,43 @@ module MarkdownServer
         raise RegexpError, e.message
       end
 
+      def client_ip
+        if settings.behind_proxy
+          fwd = env["HTTP_X_FORWARDED_FOR"].to_s.split(",").map(&:strip).first
+          fwd && !fwd.empty? ? fwd : env["REMOTE_ADDR"]
+        else
+          env["REMOTE_ADDR"]
+        end
+      end
+
+      def setup_config
+        @setup_config ||= begin
+          path = File.join(root_dir, ".setup.yml")
+          (File.exist?(path) && YAML.safe_load(File.read(path))) || {}
+        rescue StandardError
+          {}
+        end
+      end
+
+      def admin?
+        return true if session[:admin]
+
+        adm = setup_config["admin"]
+        return false unless adm.is_a?(Hash)
+
+        return true if adm["ip"].to_s.strip == client_ip
+
+        if adm["user"] && adm["pw"]
+          auth = request.env["HTTP_AUTHORIZATION"].to_s
+          if auth.start_with?("Basic ")
+            user, pw = Base64.decode64(auth[6..]).split(":", 2)
+            return true if user == adm["user"].to_s && pw == adm["pw"].to_s
+          end
+        end
+
+        false
+      end
+
     end
 
     # Routes
@@ -744,6 +788,41 @@ module MarkdownServer
       redirect "/browse/"
     end
 
+    get "/setup-info" do
+      @title = "Setup Info"
+      @client_ip = client_ip
+      @is_admin = admin?
+      @served_path = root_dir if @is_admin
+      @public_config = setup_config.reject { |k, _| k == "admin" }
+      erb :setup_info
+    end
+
+    get "/admin/login" do
+      @title = "Admin Login"
+      @error = session.delete(:login_error)
+      @return_to = params[:return_to]
+      erb :admin_login
+    end
+
+    post "/admin/login" do
+      adm = setup_config["admin"]
+      if adm.is_a?(Hash) &&
+         params[:username] == adm["user"].to_s &&
+         params[:password] == adm["pw"].to_s
+        session[:admin] = true
+        return_to = params[:return_to].to_s
+        redirect(return_to.start_with?("/") ? return_to : "/")
+      else
+        session[:login_error] = "Invalid username or password."
+        redirect "/admin/login"
+      end
+    end
+
+    get "/admin/logout" do
+      session.clear
+      redirect "/"
+    end
+
     get "/browse/?*" do
       requested = params["splat"].first.to_s
       requested = requested.chomp("/")
@@ -755,7 +834,14 @@ module MarkdownServer
       end
 
       if File.directory?(real_path)
-        render_directory(real_path, requested)
+        index = settings.index_file
+        index_path = index && File.join(real_path, index)
+        if index_path && File.file?(index_path)
+          index_rel = requested.empty? ? index : "#{requested}/#{index}"
+          render_file(index_path, index_rel)
+        else
+          render_directory(real_path, requested)
+        end
       else
         render_file(real_path, requested)
       end

data/lib/markdown_server/version.rb

@@ -1,3 +1,3 @@
 module MarkdownServer
-  VERSION = "0.5.8"
+  VERSION = "0.5.10"
 end

data/views/admin_login.erb

@@ -0,0 +1,24 @@
+<div class="title-bar">
+  <h1 class="page-title">Admin Login</h1>
+</div>
+
+<div class="md-content" style="max-width: 360px;">
+  <% if @error %>
+    <p style="color: #b33; margin-bottom: 1rem;"><%= h(@error) %></p>
+  <% end %>
+
+  <form method="post" action="/admin/login">
+    <input type="hidden" name="return_to" value="<%= h(@return_to.to_s) %>">
+    <table class="meta-table" style="margin-bottom: 1rem;">
+      <tr>
+        <th class="blb-th">Username</th>
+        <td><input type="text" name="username" autofocus style="width:100%;padding:2px 4px;"></td>
+      </tr>
+      <tr>
+        <th class="blb-th">Password</th>
+        <td><input type="password" name="password" style="width:100%;padding:2px 4px;"></td>
+      </tr>
+    </table>
+    <button type="submit" style="padding:4px 16px;">Log in</button>
+  </form>
+</div>

data/views/layout.erb

@@ -319,10 +319,12 @@
     a.wiki-link {
       color: #6a8e3e;
       border-bottom: 1px dashed #6a8e3e;
+      margin: 0 0.2rem;
     }
     span.wiki-link.broken {
       color: #c44;
       border-bottom: 1px dashed #c44;
+      margin: 0 0.2rem;
     }
 
     /* Raw/code view */

data/views/setup_info.erb

@@ -0,0 +1,28 @@
+<div class="title-bar">
+  <h1 class="page-title">Setup Info</h1>
+</div>
+
+<div class="md-content">
+  <% if @is_admin %>
+    <p><strong>You are an administrator.</strong></p>
+  <% end %>
+
+  <table class="meta-table">
+    <tr><th>Your IP</th><td><%= h(@client_ip) %></td></tr>
+    <% if @served_path %>
+      <tr><th>Serving</th><td><%= h(@served_path) %></td></tr>
+    <% end %>
+  </table>
+
+  <% unless @public_config.empty? %>
+    <h3>Configuration</h3>
+    <table class="meta-table">
+      <% @public_config.each do |key, value| %>
+        <tr>
+          <th><%= h(key.to_s) %></th>
+          <td><%= h(value.to_s) %></td>
+        </tr>
+      <% end %>
+    </table>
+  <% end %>
+</div>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: markdownr
 version: !ruby/object:Gem::Version
-  version: 0.5.8
+  version: 0.5.10
 platform: ruby
 authors:
 - Brian Dunn
@@ -100,15 +100,19 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- bin/Dockerfile.markdownr
 - bin/markdownr
+- bin/push-to-docker
 - lib/markdown_server.rb
 - lib/markdown_server/app.rb
 - lib/markdown_server/version.rb
+- views/admin_login.erb
 - views/directory.erb
 - views/layout.erb
 - views/markdown.erb
 - views/raw.erb
 - views/search.erb
+- views/setup_info.erb
 homepage: https://github.com/brianmd/markdown-server
 licenses:
 - MIT