thanos-slack-files

    0.3.3 • Public • Published

    Image of Infinite Cleaning Gauntlet

    thanos-slack-files

    simple app to easily remove the largest files and free up storage for your free-tier slack team/workspace.

    Requirements

    To use this app, you will need the following:

    Note: because of the nature of this app, you may also want to have a private slack channel druedicated to it. Slack does not specifically lock down permissions to apps by default; see: https://stackoverflow.com/questions/44200239/restrict-slack-slash-command-access for details

    Usage

    There are two ways to use this app, depending on your security needs and other factors:

    As a Local App

    Once requirements have been installed:

    1. Open your terminal
    2. cd to the directory where you intend to install and type
    npm install -g thanos-slack-files
    

    Be sure to configure the relevant parameters in a .env file, go to your cloned repo directory, and then simply run:

    thanos
    

    You will then get a notice in your slack channel telling you that your app is Thanos'ing, along with what file is being deleted.

    As a Slack Slash Command

    Once requirements have been installed:

    1. On the machine/server you'd like to host on, open your terminal
    2. cd to the directory where you intend to install and enter the following
    git init . && git remote add origin https://github.com/rob2d/thanos_slack_files.git && git pull origin master && npm i && npm i -g pm2
    
    1. launch the server by running
    npm run start
    

    You should now be running a cluster of the server via PM2.

    1. Now in your slack panel, add a Slack Command under you app which points to <yourserverurl:3002>/api/thanos. Your server should now be listening for a /thanos command.

    Configuration

    Create a file named .env in your cloned repo's directory (or install directory for executable), and add the following contents (without including the [] characters or anything in between!):

    SLACK_CHANNEL=[your-slack-channel-string]
    SLACK_TOKEN=[your-app-oauth-token]
    SLACK_USERS=[{optional}if specified, comma separated strings for allowed usernames that can run /thanos]
    DELETION_INTERVAL=[{optional}seconds-btwn-deleting-files]
    PORT=[{optional}port_number_on_server(default 3002)]
    

    Contributing

    PR requests welcome. Please be reasonable with issue reports, and use stack exchange if it is simple for a technical question vs an actual issue. This repo has been created and tested exclusively on Windows 10 so far, so I'm hoping to get some feedback from people on other OS/distros.

    Note

    This is open source/done on my free time. As such, there are likely to be things that can be improved that I may not necessarily get to. Your support is appreciated throughout this process.

    Thanks!

    Install

    npm i thanos-slack-files

    DownloadsWeekly Downloads

    6

    Version

    0.3.3

    License

    ISC

    Unpacked Size

    24.4 kB

    Total Files

    17

    Last publish

    Collaborators

    • robftw