Skip to content

Commit 2e9c12e

Browse files
authored
Update README.md
1 parent f94d639 commit 2e9c12e

File tree

1 file changed

+10
-14
lines changed

1 file changed

+10
-14
lines changed

README.md

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,21 @@
11
# getsum : Tool for validating and calculating checksums
22

3-
***getsum*** calculates and validates checksum of files remotely or locally. According to user choice, local downloads can be prevented if checksum mismatch. You can also run ***getsum*** in listen mode so you can run remotely deploy on your server or cloud provider of your choice then use another getsum as client. I get the idea from https://blog.linuxmint.com/?p=2994 so I thought it would be great fit for people who host binaries as well as users to validate their checksum. In validation mode if remote servers are present, then application first calculates checksum on remote servers and if there is a match it does downloads the file and run another calculation locally.
3+
***getsum*** calculates and validates checksum of files remotely or locally. According to user choice, local downloads can be prevented if their checksum mismatch. You can also run application in listen mode so you can remotely deploy on your server or cloud provider of your choice then use another getsum as client. I get the idea from https://blog.linuxmint.com/?p=2994 so I thought it would be great fit for people who host binaries as well as users to validate their checksum. In validation mode if remote servers are present, then application first calculates checksum on remote servers and if there is a match it does downloads the file and run another calculation locally.
44

55
[![Watch the full record](docs/main.gif)](https://asciinema.org/a/ovpGNqNS56qlrKevUllOks1qT)
66

77
**Installation**
88

9-
Current binaries are stored on [release page](https://github.com/getsumio/getsum/releases/tag/v1.0). Please consider application only tested on Fedora 30. Windows binaries had path problem that executable didnt run, i will commit fix next week.
9+
Current binaries are stored on [release page](https://github.com/getsumio/getsum/releases). Please consider application only tested on Fedora 30.
1010

11-
On linux:
11+
linux example:
1212
```
1313
cd /location/to/store
14-
wget https://github.com/getsumio/getsum/releases/download/v1.0/getsum-linux-amd64.tar.gz
1514
tar xzvf getsum-linux-amd64.tar.gz
16-
mv builds/linux/amd64/getsum .
17-
rm -f ./builds
18-
```
19-
then add binary location to /etc/profile or ~/.bashrc
20-
21-
or if you have alternatives installed:
15+
cd builds/linux/amd64/
16+
./getsum -h
17+
```
18+
add binary location to /etc/profile or ~/.bashrc or if you have alternatives installed:
2219
```
2320
alternatives --install /usr/bin/getsum getsum /location/to/store/getsum 0
2421
```
@@ -78,7 +75,7 @@ getsum -remoteOnly https://some.server.address/binary cf1a31c3acf3a1c3f2a13cfa13
7875
getsum -localOnly https://some.server.address/binary cf1a31c3acf3a1c3f2a13cfa13
7976
```
8077

81-
**Running in listen mode**
78+
**Running in serve mode**
8279

8380
Running in serve mode param is *-s* default listen address is *127.0.0.1* and port is *8088*. In serve mode files are not stored that they are removed after calculation. Set *-dir* param to change save folder, default is current location. There is no authentication method provided by this application, you need to handle it if you are planning to run servers in public.
8481
```
@@ -110,7 +107,7 @@ getsum -sc /tmp/servers.yml /path/to/file
110107
**In case of 'os' selected**:
111108
below commands will be called:
112109
* For ***Linux/Mac*** : *md5sum,sha1sum,sha224sum,sha256sum,sha384sum,sha512sum*
113-
* For ***Windows*** : *certUtil* will be called
110+
* For ***Windows*** : *certUtil* will be called
114111

115112
**Supported Algorithms**:
116113
* ***Windows***: MD2, MD4, MD5, SHA1, SHA224, SHA256, SHA384, SHA512
@@ -129,8 +126,7 @@ I will also write browser addons next week (4.November+) so you can set your ser
129126
I really wanted to add native lambda, cloud functions support for different providers but each provider has their own limits i.e. 200mb storage space or 2GB memory, so its currently postponed.
130127

131128
**Issues**
132-
Application tested only on linux. Windows binary had path problem I will fix. If you had issues please raise here. Also unit tests are missing I will implement this month.
129+
Application tested only on linux. If you had issues please raise here. Also unit tests are missing I will implement this month.
133130

134131
**How to support**
135132
Code review, pull requests, raise issues, promote :)
136-
**

0 commit comments

Comments
 (0)