Feature: serve multiple domains on a single instance #447

Stängd
igalic vill sammanfoga 5 incheckningar från s[2]s in i master
igalic kommenterad 5 år sedan (Migrerad från github.com)

This Pull Request addresses #94.
We start by adding custom_domain to the blogs table.

Blogs with custom domains have special routes with higher priority, but administrative routes will remain on the instance host.

Domain administration is left to the user (and/or admin)
(but we might be able to provide a check on whether it's already correctly configured)

This Pull Request addresses #94. We start by adding `custom_domain` to the `blogs` table. Blogs with custom domains have special routes with higher priority, but administrative routes will remain on the instance host. Domain administration is left to the user (and/or admin) (but we might be able to provide a check on whether it's already correctly configured)
codecov[bot] kommenterad 5 år sedan (Migrerad från github.com)

Codecov Report

Merging #447 into master will decrease coverage by 2.04%.
The diff coverage is 2.32%.

@@            Coverage Diff             @@
##           master     #447      +/-   ##
==========================================
- Coverage   26.89%   24.84%   -2.05%     
==========================================
  Files          65       64       -1     
  Lines        8966     6375    -2591     
==========================================
- Hits         2411     1584     -827     
+ Misses       6555     4791    -1764
# [Codecov](https://codecov.io/gh/Plume-org/Plume/pull/447?src=pr&el=h1) Report > Merging [#447](https://codecov.io/gh/Plume-org/Plume/pull/447?src=pr&el=desc) into [master](https://codecov.io/gh/Plume-org/Plume/commit/bdfad844d7939e757929d1643132a9346f82dd66?src=pr&el=desc) will **decrease** coverage by `2.04%`. > The diff coverage is `2.32%`. ```diff @@ Coverage Diff @@ ## master #447 +/- ## ========================================== - Coverage 26.89% 24.84% -2.05% ========================================== Files 65 64 -1 Lines 8966 6375 -2591 ========================================== - Hits 2411 1584 -827 + Misses 6555 4791 -1764 ```
igalic kommenterad 5 år sedan (Migrerad från github.com)

after taking a break to work on refactoring with Clippy (#462) , a lot has happened since:

  • Blogs can now be edited, and have banners and icons (#460), quite useful, if your front-page is the blog page!
  • We have a central Config struct (#494)
  • Blogs & Users now have an Fqn field which doesn't need to be recalculated (#457)

Meanwhile, a community member has reported, that Plume works via Tor, without any modifications.

Now, adding the custom domain feature, would possibly require modification.
Regardless, we need to rethink our approach to routing…
…and, i could use some help with that.

Here's some of my own thoughts:

  • The route ranking (alone) feels limiting in that regard.
  • we have two route functions which do the same thing, only slightly different, so this needs some abstraction
  • we have two types of routes: known domain, or default domain (this could would also be taken for unknown domains)
  • to properly map onion domains, the Host would need to become an array

A closing summary: it would be nice if route functions with custom_domains: Host(s) were automatically ranked higher, otherwise, we'd need to split the mounting of routes into: known-domains / unknown or default domain.

after taking a break to work on refactoring with Clippy (#462) , a lot has happened since: - Blogs can now be edited, and have banners and icons (#460), quite useful, if your front-page is the blog page! - We have a central Config struct (#494) - Blogs & Users now have an Fqn field which doesn't need to be recalculated (#457) Meanwhile, a community member has reported, that Plume works via Tor, without any modifications. Now, adding the custom domain feature, would possibly require modification. Regardless, we need to rethink our approach to routing… …and, i could use some help with that. Here's some of my own thoughts: - The route ranking (alone) feels limiting in that regard. - we have two route functions which do the same thing, only slightly different, so this needs some abstraction - we have two types of routes: known domain, or default domain (this could would also be taken for unknown domains) - to properly map onion domains, the `Host` would need to become an array A closing summary: it would be nice if route functions with `custom_domains: Host(s)` were automatically ranked higher, otherwise, we'd need to split the mounting of routes into: known-domains / unknown or default domain.
igalic (Migrerad från github.com) granskad av 5 år sedan
igalic (Migrerad från github.com) lämnade en kommentar

some thoughts, after a long hiatus

some thoughts, after a long hiatus
@ -0,0 +1,2 @@
-- Adding custom domain to Blog as an optional field
ALTER TABLE blogs ADD COLUMN custom_domain VARCHAR DEFAULT NULL UNIQUE;
igalic (Migrerad från github.com) kommenterad 5 år sedan

we should also verify no one is trying to su their custom_domain to our instance domain

we should also verify no one is trying to su their `custom_domain` to our instance domain
igalic (Migrerad från github.com) kommenterad 5 år sedan

btw, i was wondering if this should be an array, and i've come to the conclusion that it should most definitely not be one

btw, i was wondering if this should be an array, and i've come to the conclusion that it should most definitely not be one
igalic (Migrerad från github.com) kommenterad 5 år sedan

okay, so before we mount anything, we need to select custom_domain from blogs and perhaps cache that on startup
if that is empty, we proceed like before, if it's not we should route into into our custom routes

the problem is, that we cannot extract the host header (or any header) before we are in a route functions, because that's where all of rocket's main functionality happens, so we need to think of something

okay, so before we mount anything, we need to `select custom_domain from blogs` and perhaps cache that on startup if that is empty, we proceed like before, if it's not we *should* route *into* into our custom routes the problem is, that we cannot extract the host header (or any header) before we are in a route functions, because that's where all of rocket's main functionality happens, so we need to think of something
@ -20,2 +20,4 @@
use template_utils::Ructe;
#[get("/?<page>", rank = 2)]
pub fn custom_details(
igalic (Migrerad från github.com) kommenterad 5 år sedan

many routes will need duplicated functions, and reordering

in all those cases, we should replace the actual guts of the function with a private one, and all it, once the parameters have been processed successfully

many routes will need duplicated functions, and reordering in all those cases, we should replace the actual guts of the function with a private one, and all it, once the parameters have been processed successfully
trinity-1686a granskad av 5 år sedan
Ägare

as I said (a very long time ago), we could use a Fairing to modify the path from https://somesite.com/something/idkwhat to (https://...)/custom_domain/somesite.com/something/idkwhat. I think this is the easiest way to do it, the other being to have to reorder each route and add a guard that extract the custom domain of current request, if custom domain there is (like the Host struct, but with an additional check to return forward when it's not a known custom domain)

as I said (a very long time ago), we could use a [Fairing](https://api.rocket.rs/v0.4/rocket/fairing/trait.Fairing.html#method.on_request) to modify the path from `https://somesite.com/something/idkwhat` to `(https://...)/custom_domain/somesite.com/something/idkwhat`. I think this is the easiest way to do it, the other being to have to reorder each route and add a guard that extract the custom domain of current request, if custom domain there is (like the Host struct, but with an additional check to return forward when it's not a known custom domain)
igalic (Migrerad från github.com) granskad av 5 år sedan
igalic (Migrerad från github.com) kommenterad 5 år sedan

you did, and i'm still not sure i follow this

let's make a concrete example here:

i have a blog (Words words words) with a custom_domain (https://words.eena.me/) on the instance https://blogs.igalic.co (so, https://blogs.igalic.co/~/words/)

someone makes a request for https://words.eena.me/

what do they see in their browser's URL bar?
what happens in our code?

someone makes a request for https://blogs.igalic.co/~/words/

here, i'm expecting a redirect to https://words.eena.me/

is this what happens, or do we have to do anything special?

thank you very much for your reply, btw, and for your patience

you did, and i'm still not sure i follow this let's make a concrete example here: i have a blog (Words words words) with a custom_domain (https://words.eena.me/) on the instance https://blogs.igalic.co (so, https://blogs.igalic.co/~/words/) someone makes a request for https://words.eena.me/ what do they see in their browser's URL bar? what happens in our code? someone makes a request for https://blogs.igalic.co/~/words/ here, i'm expecting a redirect to https://words.eena.me/ is this what happens, or do we have to do anything special? thank you very much for your reply, btw, and for your patience
trinity-1686a granskad av 5 år sedan
Ägare

What they see in their url bar : https://words.eena.me/ (unchanged)
What happens in our code : it's treated as /custom_domain/words.eena.me/ (or anything actually, even /~/words/ if we want. In a Fairing, we have the host header, the (mutable) request path and access to the database, the sky's the limit)
Someone makes a request for https://blogs.igalic.co/~/words/ , this change nothing. If we want it to redirect to https://words.eena.me/, we have to implement it

Also, made me think that as we use absolute urls, most links could be broken, depending on how the Fairing is made exactly (just concatenating path versus trying to understand them a bit)

What they see in their url bar : https://words.eena.me/ (unchanged) What happens in our code : it's treated as `/custom_domain/words.eena.me/` (or anything actually, even `/~/words/` if we want. In a Fairing, we have the host header, the (mutable) request path and access to the database, the sky's the limit) Someone makes a request for https://blogs.igalic.co/~/words/ , this change nothing. If we want it to redirect to https://words.eena.me/, we have to implement it Also, made me think that as we use absolute urls, most links could be broken, depending on how the Fairing is made exactly (just concatenating path versus trying to understand them a bit)
Denna pull-förfrågan kan inte öppnas igen eftersom branchen tagits bort.
You can also view command line instructions.

Step 1:

From your project repository, check out a new branch and test the changes.
git checkout -b feat/custom-domains master
git pull origin feat/custom-domains

Step 2:

Merge the changes and update on Forgejo.
git checkout master
git merge --no-ff feat/custom-domains
git push origin master
Logga in för att delta i denna konversation.
Inga granskare
Ingen Milsten
Ingen tilldelad
2 Deltagare
Notiser
Förfallodatum
Förfallodatumet är ogiltigt eller utanför gränserna. Använd formatet 'åååå-mm-dd'.

Inget förfallodatum satt.

Beroenden

No dependencies set.

Reference: Plume/Plume#447
Laddar…
Det finns inget innehåll än.