Skip to content

Commit

Permalink
doc mdx cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
josephdadams committed Jan 22, 2024
1 parent 4e75c09 commit 3e66032
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 6 deletions.
5 changes: 3 additions & 2 deletions docs/docs/installation/from-source.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,13 @@ sidebar_position: 3
## Installation
To try out the latest features, you will likely need to build and run TallyArbiter from source. But no worries, it's very easy.

You must have Node.js installed. You can download it here: <https://nodejs.org/en/download/>.
You must have Node.js installed. You can download it here: https://nodejs.org/en/download/

If you're on MacOS, you may also need to download and install XCode Command Line Tools.

Download the Tallly Arbiter source code. You can download it directly from GitHub, or you can use `git` from the command line to download the files.

To use `git`, you must have it installed: <https://git-scm.com/book/en/v2/Getting-Started-Installing-Git>
To use `git`, you must have it installed: https://git-scm.com/book/en/v2/Getting-Started-Installing-Git

Type `git clone https://github.com/josephdadams/tallyarbiter` to download the source code. This will download to a subfolder of your current working folder.

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/usage/control-interface.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ sidebar_position: 1

# Control Interface
TallyArbiter runs an HTTP server listening on port `4455`. If this port is in use and cannot be opened, you will receive an error.
To get to the web interface, open your browser to <http://127.0.0.1:4455> if you're on the same machine where you're running the software. If now, just replace `127.0.0.1` with the IP of that machine.
To get to the web interface, open your browser to http://127.0.0.1:4455 if you're on the same machine where you're running the software. If now, just replace `127.0.0.1` with the IP of that machine.

If you're running the Desktop App, you get a window showing the GUI. However, the web interface is also available at the url described above.

## Configuration
In the configuration interface, the settings page is available at `/settings`: <http://127.0.0.1:4455/settings>
In the configuration interface, the settings page is available at `/settings`: http://127.0.0.1:4455/settings
**This page is restricted by a username and password. The default username is `admin` and the default password is `12345`.**

All the changes you make there are saved to a `config.json` file. This file should also be backed up frequently to prevent data loss when updating. It's path is different depending on the OS that you're running:
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/usage/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,11 @@ If you cannot reach the logs via the UI, you can view those files manually. The
</tr>
<tr>
<td>MacOS</td>
<td><b><code>~/Library/Preferences/TallyArbiter/logs</code></b><br/><br/>(<code>~</code> points to your home directory. The full path will look something like this: <code>/Users/USERNAME/Library/Preferences/TallyArbiter/logs</code>, but you need to replace <code>USERNAME</code> with your username)</td>
<td><b><code>&#126;/Library/Preferences/TallyArbiter/logs</code></b><br/><br/>(<code>&#126;</code> points to your home directory. The full path will look something like this: <code>/Users/USERNAME/Library/Preferences/TallyArbiter/logs</code>, but you need to replace <code>USERNAME</code> with your username)</td>
</tr>
<tr>
<td>Linux / Raspberry Pi</td>
<td><b><code>~/.local/share/TallyArbiter/logs</code></b><br/><br/>(<code>~</code> points to your home directory. The full path will look something like this: <code>/Users/USERNAME/.local/share/TallyArbiter/logs</code>, but you need to replace <code>USERNAME</code> with your username)</td>
<td><b><code>&#126;/.local/share/TallyArbiter/logs</code></b><br/><br/>(<code>&#126;</code> points to your home directory. The full path will look something like this: <code>/Users/USERNAME/.local/share/TallyArbiter/logs</code>, but you need to replace <code>USERNAME</code> with your username)</td>
</tr>
</tbody>
</table>

0 comments on commit 3e66032

Please sign in to comment.