https://github.com/ssbc/ssb-first-aid-kit

A user-friendly app for diagnosing and fixing problems with your Scuttlebutt installation
https://github.com/ssbc/ssb-first-aid-kit

Last synced: about 1 month ago
JSON representation

A user-friendly app for diagnosing and fixing problems with your Scuttlebutt installation

• Host: GitHub
• URL: https://github.com/ssbc/ssb-first-aid-kit
• Owner: ssbc
• License: agpl-3.0
• Created: 2019-10-24T10:18:49.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2022-02-17T11:52:49.000Z (over 2 years ago)
• Last Synced: 2024-04-14T12:03:39.715Z (5 months ago)
• Language: Vue
• Size: 2.5 MB
• Stars: 15
• Watchers: 11
• Forks: 3
• Open Issues: 29
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ssb-first-aid-kit

A user-friendly app for diagnosing and fixing problems with your Scuttlebutt installation



## Features

* See if this app can connect to a running client.

* See the status of your database (flumedb) indexes.

* See the status of other clients replicating you (using ebt)

* A button for deleting your database indexes if they seem stuck or broken.

## Installing and using the app

Download and install [the latest release](https://github.com/ssbc/ssb-first-aid-kit/releases/latest) (`.AppImage` for Linux, `.dmg` for macOS, or `.exe` for Windows), and then start it.

Also start your regular scuttlebutt client (e.g. Patchwork, Patchbay, etc.) on the same machine. This is needed for some features (like viewing the index progress) to work.

When running the app, if you're not sure what to do to fix your problem, you can ask people on Scuttlebutt what to do, or if you don't have access to Scuttlebutt, you can ask in the online [irc chat](https://kiwiirc.com/nextclient/irc.libera.chat/#scuttlebutt).

## Developing the app

* `git clone` it

* `npm install`

* `npm run dev` launches the app with hot/automatic reloading when you save files. At first it shows a blank screen though, and you need to refresh the page (ctrl+R). You only need to do this once though, after that it should reload automatically.

## Making a release

To make a release commit and tag, do

```

npm version $TYPE

```

where `$TYPE` is either `major`, `minor`, or `patch`. Then push it with

```

git push --tags origin master

```

(the `--tags` is needed otherwise git doesn't push the tag, and `origin master` is needed otherwise it only pushes the tag, not also the commit)

After the automatic builds are done there should be a new draft release on the releases page on GitHub.

## License

This project is [licensed](./LICENSE) under AGPL-3.0