feat: basepath routing for DevServer vhost emulation #59
Conversation
lib/mix/tasks/tableau.server.ex
Outdated
| case Application.get_env(:tableau, :config)[:base_path] do | ||
| "" -> "" | ||
| path -> "/" <> path | ||
| end |
There was a problem hiding this comment.
You can use Path.join/2 here
lib/tableau/router.ex
Outdated
| @@ -14,7 +16,7 @@ defmodule Tableau.Router do | |||
| plug :rerender | |||
|
|
|||
| plug Tableau.IndexHtml | |||
| plug Plug.Static, at: "/", from: "_site", cache_control_for_etags: "no-cache" | |||
| plug Plug.Static, at: "/#{basepath}", from: "_site", cache_control_for_etags: "no-cache" | |||
There was a problem hiding this comment.
I would also use Path.join/2 here as well.
There was a problem hiding this comment.
I used Path.join/2, and also fixed the warning associated with Application.get_env/2.
| @@ -5,6 +5,7 @@ defmodule Tableau.Config do | |||
|
|
|||
| defstruct [ | |||
| :url, | |||
| base_path: "", | |||
There was a problem hiding this comment.
Please add documentation for this. Its in the Tableau moduledoc
|
I added |
lib/mix/tasks/tableau.server.ex
Outdated
| case Application.get_env(:tableau, :config)[:base_path] do | ||
| "" -> "" | ||
| path -> Path.join("/", path) | ||
| end |
There was a problem hiding this comment.
| case Application.get_env(:tableau, :config)[:base_path] do | |
| "" -> "" | |
| path -> Path.join("/", path) | |
| end | |
| Path.join("/", Application.get_env(:tableau, :config)[:base_path]) |
lib/tableau.ex
Outdated
| @@ -4,9 +4,69 @@ defmodule Tableau do | |||
|
|
|||
| * `:include_dir` - string - Directory that is just copied to the output directory. Defaults to `extra`. | |||
| * `:timezone` - string - Timezone to use when parsing date times. Defaults to `Etc/UTC`. | |||
| * `:base_path - string - base path to use with Github Pages or web-servers that use a location prefix for Vhosts | |||
There was a problem hiding this comment.
| * `:base_path - string - base path to use with Github Pages or web-servers that use a location prefix for Vhosts | |
| * `:base_path - string - Development server root . Defaults to `/`. |
lib/tableau.ex
Outdated
|
|
||
| ## Working with Github Pages or web-server Vhosts | ||
|
|
||
| Github Pages provides a root url like `https://andyl.github.io/xmeyers`, where | ||
| the `xmeyers` prefix is a virtual host identifier tied to the repo at | ||
| `https://github.com/andyl/xmeyers`. | ||
|
|
||
| With Nginx and Apache it is common to use a location prefix for Vhosts. | ||
| Here is an example NGINX config snippet: | ||
|
|
||
| ``` | ||
| server { | ||
| listen 80; | ||
| server_name myhost.com; | ||
|
|
||
| location /site1 { | ||
| # Configuration for site1 - eg the root directive to a directory | ||
| # root /var/www/site1; | ||
| } | ||
|
|
||
| location /site2 { | ||
| # Configuration for site2 | ||
| # Similar configuration as site1, adjusted for site2 specifics | ||
| } | ||
|
|
||
| # Other configuration... | ||
| } | ||
| ``` | ||
|
|
||
| To make Tableau's development server (`mix tableau.server`) also use a Vost | ||
| prefix, configure your app with the `:base_path` attribute. With that, your | ||
| website HREFs will work in both development and production. | ||
|
|
||
| ## Example | ||
|
|
||
| In `config/config.exs`: | ||
|
|
||
| ```elixir | ||
| config :tableau, :config, | ||
| url: "http://localhost:4999", | ||
| base_path: "xmeyers", | ||
| markdown: [ | ||
| ... | ||
| ] | ||
| ``` | ||
|
|
||
| In `root_layout.ex`: | ||
|
|
||
| ```elixir | ||
| def template(assigns) do | ||
| ~H\""" | ||
| <!DOCTYPE html> | ||
| <html> | ||
| <head> | ||
| <title>Xmeyers</title> | ||
| <link rel="icon" href="/xmeyers/static/img/favicon.ico" type="image/x-icon" /> | ||
| <link rel="stylesheet" type="text/css" href="/xmeyers/css/site.css" /> | ||
| ... | ||
| ``` |
lib/tableau/router.ex
Outdated
| @@ -6,6 +6,8 @@ defmodule Tableau.Router do | |||
|
|
|||
| require Logger | |||
|
|
|||
| @base_path Path.join("/", Application.compile_env(:tableau, :config)[:base_path] || "") | |||
There was a problem hiding this comment.
I don't think you actually need the || "" since it defaults to ""
There was a problem hiding this comment.
In my testing it defaults to nil, which causes Path.join/2 to raise an error.
There was a problem hiding this comment.
Oh, sorry, I was thinking of the default coming from the struct. This is fine then, should also add to the other spot instead of that case expression
There was a problem hiding this comment.
I took a closer look at this. Turns out there is a small difference in the arguments accepted by Application.get_env and Application.compile_env. I believe the forms I used are correct, and tested it with and without a base_path configuration.
|
All changes done. |
|
awesome work, thanks! |
This is a quick working solution to #57 - it allows the site developer to configure a
:base_pathattribute inconfig.exs.The
base_pathattribute is used inrouter.exto adjust the static path, and inMix.Tasks.Tableau.Serverto adjust the logger message.If the
:base_pathis not set inconfig.exs, the system behaves just as it does now.For my use case as described in #57, this solution works great!
If you reject this PR in favor of a better solution, no problemo. If you want docs, or tests etc. I will supply. Just putting this out there for ideas and feedback.