Skip to content
This repository has been archived by the owner on Nov 8, 2023. It is now read-only.

Latest commit

 

History

History
106 lines (72 loc) · 4.79 KB

readme.md

File metadata and controls

106 lines (72 loc) · 4.79 KB
Raw

Notes: the project was intented as a DNS + frontend only application for handling subdomains on a wildcard domain *.4000.network. But there are limitations from cloudlfare domains (custom nameservers need an expensive PRO plan), when the page is hosted with vercel. When the page is hosted by github pages, it seems cloudlfare (DNS) and github pages, do not want to accept wildcard subdomains DNS. Therefore this project is "dead" but used to workd (when the domain was rented at google domains). One solution is to continue it without subdomains (eg: internet4000.4000.network would just be 4000.network/internet4000) but where is the fun in this.

4000.network

This project is a prototype attempt at creating a user managed network of profiles, with a diversity of content. 4000.network should provide a straight forward way to publish and customize a public web page composed of HTML widgets, and web-components.

It currently relies on github, which provides the mechanism to reserve a subdomain on githubUsername.4000.network. Note that this will eventually be moved to githubUsername.github.4000.network.

Create a 4000 network subdomain page

  1. With a github account, create a repository named .4000.network
  2. inside this repository create an empty .profile.json file (with either no content, or an empty object {} or such as this example)
  3. on github, tag the repository with the two topics 4000-network and topic:profile-json
  4. visit githubUsername.4000.network to see the profile

comming soon: interface for managing a profile and its widgets (try adding ?edit to a profile URL)

coming next: remove github dependency (todo: auth? + .profile.json hosting? + sync to github repo? supabase? DID?)

then? theming? explore what can be done with "just a list of widgets" (aka registered custom-elements and default html elements — sanitized & 'white'listed -)? Responsive CSS themes? default CSS vars?

Development

4000.network is mainly a vanilla javascript web-component, network-4000.

To run the projec locally (it uses vite as build tool):

  • clone repository
  • npm i
  • npm run dev

To Deploy a build:

  • npm run build
  • publish the ./dist folder
  • customize the ./public/.env.production.json file

.env.{production}.json

In this file are all the "public environment"

How to test the url and subdomains

When running a local server (here with vite), we can use subdomains in the URL just as with "normal live URLs"; so if our app runs on port 4001:

Subdomains

How subdomain handling used to works

  • cloudflare A record on @ (root) to vercel DNS ip
  • managed (authorized) by vercel DNS on *.4000.network and vercel.json
  • handled by the javascript web component network-4000.subdomain getter
  • currently make a query to github.com/:subdomain/.4000.network/.env.json

Notes:

  • whatever was tried, could not make it work with github pages and cloudflare DNS
  • maybe if not vercel and subdomain hosting, make it work with /:gh_username, as path of the app?
  • to use *.4000.network wildcard subdomain with a domain name rented at cloudflare, and a page hosted at vercel, it is required to have a Cloudflare pro plan (mega expensive), because it is the only way to use the vercel nameservers (required by vercel). Therefore we cannot do that.

Dependencies

HTML & user content Sanitizer

Using DOMPurify for cleaning un-wanted user content.

external web-components

Currently evaluating how to best import user defined npm modules, web components that are made available in the list of widgets you can add to your page.

There widgets could be:

  • defined by this application
  • defined by the user who makes a page (a list of npm cdn imports)?

These present a lot a security issues, and has to be investigated in depth.

The file src/lib/sdk.js currently has a list, AUTHORIZED_WIDGETS_MAP.

  • the approach, is to make white list of elements, and their attributes.
  • but this goes into conflict with DOMPUrify, which does the same job.

Also note rehype-sanitize, used in goog-space

It is also a tedious work to authorize and list all possible widgets/web-components that should be allowed to be used by users.