Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implementing Matrix commands #40

Draft
wants to merge 10 commits into
base: main
Choose a base branch
from
Draft

Implementing Matrix commands #40

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
6f52de1
Added Matrix env variable configuration
Denperidge Feb 9, 2023
998cdbf
Fixed printRoomInfo map iteration
Denperidge Feb 9, 2023
f4c3d3e
Fixed rl in g-s, matrix room load in go, refactor
Denperidge Feb 9, 2023
fa787aa
Clarifying & refactoring gitter/rdf specific code
Denperidge Feb 10, 2023
4249426
Implemented Matrix command: List
Denperidge Feb 10, 2023
717c5f8
Re-implemented and refactored loadConfig
Denperidge Feb 10, 2023
99c6395
Implemented Matrix command: Init
Denperidge Feb 10, 2023
858cc4d
doRoom log can now show Matrix or Gitter roomid
Denperidge Feb 10, 2023
a3865fd
First draft of catchup
Denperidge Feb 10, 2023
3cce8a0
Fixed Matrix Message.created & crash on no content
Denperidge Feb 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions .env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Solid configuration
# Only needed when saving to Solid as opposed to your local filesystem
SOLID_IDP=https://storage.inrupt.com
SOLID_USERNAME=yourusername
SOLID_PASSWORD=

# Matrix configuration
# Only needed when the Matrix API will be used
MATRIX_USER_ID=@your:matrixid.org
MATRIX_ACCESS_TOKEN=syt_YoUr_MatrIx_Access_TokeN
MATRIX_BASE_URL=http://matrix.org

# Gitter configuration
# Only needed when the (deprecated) Gitter API will be uesd
GITTER_TOKEN=
11 changes: 10 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,16 @@ analysis tools on top of your gitter chat data? Maybe you should be using this s


## Usage
The variables referenced in this section can be configured through any of the following:
- (When using the terminal script) providing them when prompted
- Using `export` directly in your shell
- Creating a .env file (see [.env.example](.env.example))

### Solid access

If you will be storing your chats on the local filesystem, you don't need Solid access.

If you will be storing your chats on a Solid Pod (either local or remote), you will need to provide login credentials to give your script write access. You can export enviornoment variables (SOLID_IDP, SOLID_USERNAME, SOLID_PASSWORD) or let the script prompt you for the values if the environment variables are not found.
If you will be storing your chats on a Solid Pod (either local or remote), you will need to provide login credentials to give your script write access. You can export environment variables (SOLID_IDP, SOLID_USERNAME, SOLID_PASSWORD) or let the script prompt you for the values if the environment variables are not found.

### Gitter access

Expand All @@ -36,6 +41,10 @@ node gitter-solid.js list
Once you have set your shell session up with the gitter token,
you can use gitter-solid repeatedly.

### Matrix Access

To access Matrix (or Gitter using the Matrix API), you can optionally configure MATRIX_USER_ID, MATRIX_ACCESS_TOKEN & MATRIX_BASE_URL (defaults to http://matrix.org). To get an access token, you can follow the [instructions here](https://t2bot.io/docs/access_tokens/).

## Gitter rooms

In gitter, the concept of a room includes public rooms, private rooms, and private 1-1 conversations, some call *direct messaging*.
Expand Down
Loading