shithub: mycel

ref: 1c3a0cb13ff08a5a125eb675c3cf942f2a4afa7d
dir: /README.md/

View raw version
# Opossum Web Browser

Basic portable Web browser; only needs a Go compiler to compile.

The UI is built with https://github.com/mjl-/duit

Still experimental and a lot of features are missing, see website for screenshots: http://psilva.sdf.org/opossum.html

Supported features:

- rudimentary CSS/HTML5 support, large parts like float/flex layout are just stub implementations
- Server-side rendered websites
- Images (pre-loaded all at once though)
- TLS
- experimental JS/DOM can be activated (very basic jQuery examples work)
- file downloads

# Install

## Plan 9

You can download a tarball with the binary at http://psilva.sdf.org/opossum.tgz

```
./opossum-plan9-amd64.bin
```

Also `/sys/lib/tls/ca.pem` needs to be present for TLS to work. ca certs can be downloaded from the curl homepage:

```
hget https://curl.haxx.se/ca/cacert.pem > /sys/lib/tls/ca.pem
```

To compile the source Go 1.16 is needed. Probably `$GOPROXY` should be set to `https://proxy.golang.org`

```
cd cmd/browse
go run .
```

There are various command line options, visible with `-h`, most importantly to see errors:

```
go run . '-quiet=false'
```

(`-quiet=false` produces a lot of output, consider turning on scroll since processing waits for that...)

or all messages:

```
go run . '-quiet=false' '-debug=true'
```

## macOS

Requirements:

- Go
- Plan9Port

```
cd cmd/browse
go run .
```

# JS support

It's more like a demo and it's not really clear right now how much sandboxing
is really needed. A rudimentary AJAX implementation
is there though.

Use on your own Risk!

Mostly based on goja (ECMAScript 5.1) and https://github.com/fgnass/domino
(DOM implementation in JS). Some sort of DOM diffing
is needed, also AJAX functions, `getComputedStyle` etc. are either missing or stubs.
Very simple jQuery based code works though, e.g. jQuery UI Tab view
https://jqueryui.com/resources/demos/tabs/default.html or the toggle buttons on
https://golang.org/pkg There is also highly experimental ES6 support with Babel.

Try on Plan 9 with e.g.:

```
go run . '-experimentalJsInsecure=true' -startPage https://jqueryui.com/resources/demos/tabs/default.html
```

or macOS etc.:

```
go run . -experimentalJsInsecure=true -startPage https://jqueryui.com/resources/demos/tabs/default.html
```


# TODO

- load images on the fly
- implement more parts of HTML5 and CSS
- create a widget for div/span
- clean up code, support webfs, snarf