Skip to content

Commit

Permalink
readme,webdeps: Add v0.6.0
Browse files Browse the repository at this point in the history
  • Loading branch information
networkimprov committed Oct 20, 2019
1 parent 4311dc5 commit 5b0c0c5
Show file tree
Hide file tree
Showing 2 changed files with 89 additions and 53 deletions.
140 changes: 88 additions & 52 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,14 @@ i.e. it runs on personal devices and its GUI appears in a browser.

Complete documentation is provided within the app.


### Status

_20 October 2019_ -
v0.6 is released for Windows 7/8/10 & MacOS & Linux. It has been tested with Chrome & Firefox.
_New:_ search, message tags, file viewer, UI colors, logo, and more. Fixes a panic and many UI flaws.
[Release details](https://github.com/networkimprov/mnm-hammer/releases/latest)

_29 May 2019_ -
v0.5 is released. It fixes a panic on Windows, but is otherwise identical to v0.4.

Expand All @@ -45,59 +51,91 @@ _New:_ a tour with cartoons covering essential features.
_19 April 2019_ -
v0.1 is released. It has only been tested on Linux & MacOS, with Firefox.

### Quick start

### Quick Start

If you haven't received an invitation to join a TMTP service, you can set up your own.
See directions to install the server at https://github.com/networkimprov/mnm
See the [mnm relay server](https://github.com/networkimprov/mnm).

1. Download & save latest preview
|
[**Windows**](https://github.com/networkimprov/mnm-hammer/releases/download/v0.5.0/mnm-app-windows-amd64-v0.5.0.zip)
||
[**MacOS**](https://github.com/networkimprov/mnm-hammer/releases/download/v0.5.0/mnm-app-macos-v0.5.0.tgz)
||
[**Linux**](https://github.com/networkimprov/mnm-hammer/releases/download/v0.5.0/mnm-app-linux-amd64-v0.5.0.tgz)
|
[Release details](https://github.com/networkimprov/mnm-hammer/releases/latest)
You'll need Firefox or Chrome. (I endorse [Firefox](https://www.mozilla.org/en-US/firefox/) :-)

#### _Windows_ • [MacOS](#macos) • [Linux](#linux)

Also install Firefox if you don't have it: https://www.mozilla.org/en-US/firefox/
1. Download & save latest preview
[mnm-app-windows-amd64-v0.6.0.zip](https://github.com/networkimprov/mnm-hammer/releases/download/v0.6.0/mnm-app-windows-amd64-v0.6.0.zip)

1. Unpack download
Windows
a) Open the browser downloads menu, find "mnm-app-windows-amd64-v0.5.0.zip" and click "Open File".
b) Drag the item "mnm-hammer-v0.5.0" to the Downloads folder in the left-hand pane.
a) Open the browser downloads menu, find the above file and click "Open File".
b) Drag the item "mnm-hammer-v0.6.0" to the Downloads folder in the left-hand pane.
c) Open the Windows menu (bottom-left on screen), right-click "Command Prompt", and select "Run as administrator".
d) You'll see a warning "Do you want to allow the following program..."; click "Yes".
e) `cd %UserProfile%\Downloads\mnm-hammer-v0.5.0`
MacOS
a) Open the browser downloads menu, find "mnm-app-macos-v0.5.0.tgz" and click "Open File".
b) Open a Terminal window.
c) `cd ~/Downloads/mnm-hammer-v0.5.0`
Linux
a) `cd the_right_directory` # use appropriate name
b) `tar xzf mnm-app-linux-amd64-v0.5.0.tgz`
c) `cd mnm-hammer-v0.5.0`

1. Upgrade a prior release, if applicable
e) In the command window, enter `cd %UserProfile%\Downloads\mnm-hammer-v0.6.0`

1. If upgrading, move the data from a prior release
a) Stop the prior app if it's running.
b) Enter `move ..\mnm-hammer-vX.Y.Z\store .\store` &::  _X.Y.Z_ is a prior release, e.g. `0.5.0`

1. Start app
Note: the app currently logs much of its traffic with the browser to the command window.
a) Enter `mnm-hammer.exe`
b) If you see a Windows Firewall warning, check "Public networks...", then click "Allow access".

To stop the app, type `Ctrl-C`

1. Connect Firefox or Chrome
Open a browser tab, go to `localhost`.

#### _MacOS_

1. Download & save latest preview
[mnm-app-macos-v0.6.0.tgz](https://github.com/networkimprov/mnm-hammer/releases/download/v0.6.0/mnm-app-macos-v0.6.0.tgz)

1. Unpack download
a) Open the browser downloads menu, find the file above and click "Open File".
b) In the Finder, open the Go menu and select Utilities.
c) In the Utilities list, double-click Terminal.
d) In the terminal window, enter `cd ~/Downloads/mnm-hammer-v0.6.0`

1. If upgrading, replicate the data from a prior release
a) Stop the prior app if it's running.
MacOS
b) `sudo ditto ../mnm-hammer-vX.Y.Z/store ./store` # use prior version
Linux
b) `sudo cp -a ../mnm-hammer-vX.Y.Z/store .` # use prior version
b) Enter `sudo ditto ../mnm-hammer-vX.Y.Z/store ./store` # _X.Y.Z_ is a prior release, e.g. `0.5.0`

1. Start app
Windows
a) `mnm-hammer.exe`
b) If you see a Windows Firewall warning, choose "Public networks...", then click "Allow access".
MacOS & Linux
Note: the app currently logs much of its traffic with the browser to the terminal window.
a) Enter `sudo ./mnm-hammer` # starts http on port 80
or
a) Enter `./mnm-hammer --http :Port` # _Port_ is a number over 1027

To stop the app, type `Ctrl-C`

1. Connect Firefox or Chrome
Open a browser tab, go to `localhost` (or `localhost:Port` if specified above).

#### _Linux_

1. Download & save latest preview
[mnm-app-linux-amd64-v0.6.0.tgz](https://github.com/networkimprov/mnm-hammer/releases/download/v0.6.0/mnm-app-linux-amd64-v0.6.0.tgz)

1. Unpack download
a) `cd the_relevant_directory` # use appropriate name
b) `tar xzf mnm-app-linux-amd64-v0.6.0.tgz`
c) `cd mnm-hammer-v0.6.0`

1. If you're upgrading, replicate the data from a prior release
a) Stop the prior app if it's running.
b) `sudo cp -a ../mnm-hammer-vX.Y.Z/store .` # _X.Y.Z_ is a prior release, e.g. `0.5.0`

1. Start app
Note: the app currently logs much of its traffic with the browser to the terminal window.
a) `sudo ./mnm-hammer` # starts http on port 80
or
a) `./mnm-hammer --http [host]:port`
To stop the app, Ctrl-C
Note: the preview currently logs much of its traffic with the browser to the terminal window.
a) `./mnm-hammer --http :port`

To stop the app, type `Ctrl-C`

1. Connect Firefox or Chrome
Open a browser tab, go to `localhost` (or `localhost:port` if specified above).

1. Connect Firefox
Open a browser tab, go to `localhost` (or `host:port` if specified above).

### Version Numbering

Expand All @@ -108,24 +146,21 @@ Preview releases: _pp_ . 1+ . _pp_ (first & last from prior production release)
The second number is only used for previews.
Most (hopefully all) preview features & changes appear in the following production release.


### Build & Package

Requires Go 1.13.3+

a) `go get github.com/networkimprov/mnm-hammer`
b) `cd $GOPATH/src/github.com/networkimprov/mnm-hammer` # project directory can be moved out of $GOPATH
c) `./webdeps.sh` # download browser modules
d) `./pkg.sh` # make release downloads for all platforms

Building for Windows requires 2 additions to /usr/lib/go/src/syscall/syscall_windows.go:
```
var Open_FileShareDelete = false // add 1 line
func Open(...) (...) {
...
sharemode := ...
if Open_FileShareDelete { // add 3 lines
sharemode |= FILE_SHARE_DELETE
}
```
See https://github.com/golang/go/issues/32088
d) Edit _kVersionDate_ in main.go
e) `./pkg.sh` # make release downloads for all platforms

Building for Windows requires this patch to the Go source (which does not affect other programs):
[go-winfsd.patch](https://github.com/networkimprov/mnm-hammer/releases/download/v0.6.0/go-winfsd.patch)
fixes [#32088](https://github.com/golang/go/issues/32088)


### Testing

Expand Down Expand Up @@ -156,6 +191,7 @@ f) Open a browser tab, go to `localhost:8123/w/coverage.html`

Ref: https://www.elastic.co/blog/code-coverage-for-your-golang-system-tests


### License

Copyright 2018, 2019 Liam Breck
Expand Down
2 changes: 1 addition & 1 deletion webdeps.sh
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

set -e

GITHUB=https://github.com/networkimprov/mnm-hammer/releases/download/v0.2.0
GITHUB=https://github.com/networkimprov/mnm-hammer/releases/download/v0.6.0
CDN_UIKIT=https://cdnjs.cloudflare.com/ajax/libs/uikit/3.0.0-beta.40
CDN_VUE=https://cdnjs.cloudflare.com/ajax/libs/vue/2.5.22
CDN_MDI=https://cdnjs.cloudflare.com/ajax/libs/markdown-it/8.4.2
Expand Down

0 comments on commit 5b0c0c5

Please sign in to comment.