github.com
Open in
urlscan Pro
140.82.121.3
Public Scan
Submitted URL: http://file.etan.one/
Effective URL: https://github.com/tycrek/ass
Submission: On December 15 via api from US — Scanned from NL
Effective URL: https://github.com/tycrek/ass
Submission: On December 15 via api from US — Scanned from NL
Form analysis
3 forms found in the DOMGET
<form id="query-builder-test-form" action="" accept-charset="UTF-8" method="get">
<query-builder data-target="qbsearch-input.queryBuilder" id="query-builder-query-builder-test" data-filter-key=":" data-view-component="true" class="QueryBuilder search-query-builder" data-catalyst="">
<div class="FormControl FormControl--fullWidth">
<label id="query-builder-test-label" for="query-builder-test" class="FormControl-label sr-only"> Search </label>
<div class="QueryBuilder-StyledInput width-fit " data-target="query-builder.styledInput">
<span id="query-builder-test-leadingvisual-wrap" class="FormControl-input-leadingVisualWrap QueryBuilder-leadingVisualWrap">
<svg aria-hidden="true" height="16" viewBox="0 0 16 16" version="1.1" width="16" data-view-component="true" class="octicon octicon-search FormControl-input-leadingVisual">
<path d="M10.68 11.74a6 6 0 0 1-7.922-8.982 6 6 0 0 1 8.982 7.922l3.04 3.04a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215ZM11.5 7a4.499 4.499 0 1 0-8.997 0A4.499 4.499 0 0 0 11.5 7Z"></path>
</svg>
</span>
<div data-target="query-builder.styledInputContainer" class="QueryBuilder-StyledInputContainer">
<div aria-hidden="true" class="QueryBuilder-StyledInputContent" data-target="query-builder.styledInputContent"></div>
<div class="QueryBuilder-InputWrapper">
<div aria-hidden="true" class="QueryBuilder-Sizer" data-target="query-builder.sizer"><span></span></div>
<input id="query-builder-test" name="query-builder-test" value="" autocomplete="off" type="text" role="combobox" spellcheck="false" aria-expanded="false" aria-describedby="validation-3d01b0da-fe0b-40f2-8300-cc079c15bb4c"
data-target="query-builder.input" data-action="
input:query-builder#inputChange
blur:query-builder#inputBlur
keydown:query-builder#inputKeydown
focus:query-builder#inputFocus
" data-view-component="true" class="FormControl-input QueryBuilder-Input FormControl-medium" aria-controls="query-builder-test-results" aria-autocomplete="list" aria-haspopup="listbox">
</div>
</div>
<span class="sr-only" id="query-builder-test-clear">Clear</span>
<button role="button" id="query-builder-test-clear-button" aria-labelledby="query-builder-test-clear query-builder-test-label" data-target="query-builder.clearButton" data-action="
click:query-builder#clear
focus:query-builder#clearButtonFocus
blur:query-builder#clearButtonBlur
" variant="small" hidden="" type="button" data-view-component="true" class="Button Button--iconOnly Button--invisible Button--medium mr-1 px-2 py-0 d-flex flex-items-center rounded-1 color-fg-muted"> <svg aria-hidden="true" height="16"
viewBox="0 0 16 16" version="1.1" width="16" data-view-component="true" class="octicon octicon-x-circle-fill Button-visual">
<path
d="M2.343 13.657A8 8 0 1 1 13.658 2.343 8 8 0 0 1 2.343 13.657ZM6.03 4.97a.751.751 0 0 0-1.042.018.751.751 0 0 0-.018 1.042L6.94 8 4.97 9.97a.749.749 0 0 0 .326 1.275.749.749 0 0 0 .734-.215L8 9.06l1.97 1.97a.749.749 0 0 0 1.275-.326.749.749 0 0 0-.215-.734L9.06 8l1.97-1.97a.749.749 0 0 0-.326-1.275.749.749 0 0 0-.734.215L8 6.94Z">
</path>
</svg>
</button>
</div>
<template id="search-icon">
<svg aria-hidden="true" height="16" viewBox="0 0 16 16" version="1.1" width="16" data-view-component="true" class="octicon octicon-search">
<path d="M10.68 11.74a6 6 0 0 1-7.922-8.982 6 6 0 0 1 8.982 7.922l3.04 3.04a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215ZM11.5 7a4.499 4.499 0 1 0-8.997 0A4.499 4.499 0 0 0 11.5 7Z"></path>
</svg>
</template>
<template id="code-icon">
<svg aria-hidden="true" height="16" viewBox="0 0 16 16" version="1.1" width="16" data-view-component="true" class="octicon octicon-code">
<path
d="m11.28 3.22 4.25 4.25a.75.75 0 0 1 0 1.06l-4.25 4.25a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L13.94 8l-3.72-3.72a.749.749 0 0 1 .326-1.275.749.749 0 0 1 .734.215Zm-6.56 0a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042L2.06 8l3.72 3.72a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215L.47 8.53a.75.75 0 0 1 0-1.06Z">
</path>
</svg>
</template>
<template id="file-code-icon">
<svg aria-hidden="true" height="16" viewBox="0 0 16 16" version="1.1" width="16" data-view-component="true" class="octicon octicon-file-code">
<path
d="M4 1.75C4 .784 4.784 0 5.75 0h5.586c.464 0 .909.184 1.237.513l2.914 2.914c.329.328.513.773.513 1.237v8.586A1.75 1.75 0 0 1 14.25 15h-9a.75.75 0 0 1 0-1.5h9a.25.25 0 0 0 .25-.25V6h-2.75A1.75 1.75 0 0 1 10 4.25V1.5H5.75a.25.25 0 0 0-.25.25v2.5a.75.75 0 0 1-1.5 0Zm1.72 4.97a.75.75 0 0 1 1.06 0l2 2a.75.75 0 0 1 0 1.06l-2 2a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734l1.47-1.47-1.47-1.47a.75.75 0 0 1 0-1.06ZM3.28 7.78 1.81 9.25l1.47 1.47a.751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018l-2-2a.75.75 0 0 1 0-1.06l2-2a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042Zm8.22-6.218V4.25c0 .138.112.25.25.25h2.688l-.011-.013-2.914-2.914-.013-.011Z">
</path>
</svg>
</template>
<template id="history-icon">
<svg aria-hidden="true" height="16" viewBox="0 0 16 16" version="1.1" width="16" data-view-component="true" class="octicon octicon-history">
<path
d="m.427 1.927 1.215 1.215a8.002 8.002 0 1 1-1.6 5.685.75.75 0 1 1 1.493-.154 6.5 6.5 0 1 0 1.18-4.458l1.358 1.358A.25.25 0 0 1 3.896 6H.25A.25.25 0 0 1 0 5.75V2.104a.25.25 0 0 1 .427-.177ZM7.75 4a.75.75 0 0 1 .75.75v2.992l2.028.812a.75.75 0 0 1-.557 1.392l-2.5-1A.751.751 0 0 1 7 8.25v-3.5A.75.75 0 0 1 7.75 4Z">
</path>
</svg>
</template>
<template id="repo-icon">
<svg aria-hidden="true" height="16" viewBox="0 0 16 16" version="1.1" width="16" data-view-component="true" class="octicon octicon-repo">
<path
d="M2 2.5A2.5 2.5 0 0 1 4.5 0h8.75a.75.75 0 0 1 .75.75v12.5a.75.75 0 0 1-.75.75h-2.5a.75.75 0 0 1 0-1.5h1.75v-2h-8a1 1 0 0 0-.714 1.7.75.75 0 1 1-1.072 1.05A2.495 2.495 0 0 1 2 11.5Zm10.5-1h-8a1 1 0 0 0-1 1v6.708A2.486 2.486 0 0 1 4.5 9h8ZM5 12.25a.25.25 0 0 1 .25-.25h3.5a.25.25 0 0 1 .25.25v3.25a.25.25 0 0 1-.4.2l-1.45-1.087a.249.249 0 0 0-.3 0L5.4 15.7a.25.25 0 0 1-.4-.2Z">
</path>
</svg>
</template>
<template id="bookmark-icon">
<svg aria-hidden="true" height="16" viewBox="0 0 16 16" version="1.1" width="16" data-view-component="true" class="octicon octicon-bookmark">
<path
d="M3 2.75C3 1.784 3.784 1 4.75 1h6.5c.966 0 1.75.784 1.75 1.75v11.5a.75.75 0 0 1-1.227.579L8 11.722l-3.773 3.107A.751.751 0 0 1 3 14.25Zm1.75-.25a.25.25 0 0 0-.25.25v9.91l3.023-2.489a.75.75 0 0 1 .954 0l3.023 2.49V2.75a.25.25 0 0 0-.25-.25Z">
</path>
</svg>
</template>
<template id="plus-circle-icon">
<svg aria-hidden="true" height="16" viewBox="0 0 16 16" version="1.1" width="16" data-view-component="true" class="octicon octicon-plus-circle">
<path d="M8 0a8 8 0 1 1 0 16A8 8 0 0 1 8 0ZM1.5 8a6.5 6.5 0 1 0 13 0 6.5 6.5 0 0 0-13 0Zm7.25-3.25v2.5h2.5a.75.75 0 0 1 0 1.5h-2.5v2.5a.75.75 0 0 1-1.5 0v-2.5h-2.5a.75.75 0 0 1 0-1.5h2.5v-2.5a.75.75 0 0 1 1.5 0Z"></path>
</svg>
</template>
<template id="circle-icon">
<svg aria-hidden="true" height="16" viewBox="0 0 16 16" version="1.1" width="16" data-view-component="true" class="octicon octicon-dot-fill">
<path d="M8 4a4 4 0 1 1 0 8 4 4 0 0 1 0-8Z"></path>
</svg>
</template>
<template id="trash-icon">
<svg aria-hidden="true" height="16" viewBox="0 0 16 16" version="1.1" width="16" data-view-component="true" class="octicon octicon-trash">
<path
d="M11 1.75V3h2.25a.75.75 0 0 1 0 1.5H2.75a.75.75 0 0 1 0-1.5H5V1.75C5 .784 5.784 0 6.75 0h2.5C10.216 0 11 .784 11 1.75ZM4.496 6.675l.66 6.6a.25.25 0 0 0 .249.225h5.19a.25.25 0 0 0 .249-.225l.66-6.6a.75.75 0 0 1 1.492.149l-.66 6.6A1.748 1.748 0 0 1 10.595 15h-5.19a1.75 1.75 0 0 1-1.741-1.575l-.66-6.6a.75.75 0 1 1 1.492-.15ZM6.5 1.75V3h3V1.75a.25.25 0 0 0-.25-.25h-2.5a.25.25 0 0 0-.25.25Z">
</path>
</svg>
</template>
<template id="team-icon">
<svg aria-hidden="true" height="16" viewBox="0 0 16 16" version="1.1" width="16" data-view-component="true" class="octicon octicon-people">
<path
d="M2 5.5a3.5 3.5 0 1 1 5.898 2.549 5.508 5.508 0 0 1 3.034 4.084.75.75 0 1 1-1.482.235 4 4 0 0 0-7.9 0 .75.75 0 0 1-1.482-.236A5.507 5.507 0 0 1 3.102 8.05 3.493 3.493 0 0 1 2 5.5ZM11 4a3.001 3.001 0 0 1 2.22 5.018 5.01 5.01 0 0 1 2.56 3.012.749.749 0 0 1-.885.954.752.752 0 0 1-.549-.514 3.507 3.507 0 0 0-2.522-2.372.75.75 0 0 1-.574-.73v-.352a.75.75 0 0 1 .416-.672A1.5 1.5 0 0 0 11 5.5.75.75 0 0 1 11 4Zm-5.5-.5a2 2 0 1 0-.001 3.999A2 2 0 0 0 5.5 3.5Z">
</path>
</svg>
</template>
<template id="project-icon">
<svg aria-hidden="true" height="16" viewBox="0 0 16 16" version="1.1" width="16" data-view-component="true" class="octicon octicon-project">
<path
d="M1.75 0h12.5C15.216 0 16 .784 16 1.75v12.5A1.75 1.75 0 0 1 14.25 16H1.75A1.75 1.75 0 0 1 0 14.25V1.75C0 .784.784 0 1.75 0ZM1.5 1.75v12.5c0 .138.112.25.25.25h12.5a.25.25 0 0 0 .25-.25V1.75a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25ZM11.75 3a.75.75 0 0 1 .75.75v7.5a.75.75 0 0 1-1.5 0v-7.5a.75.75 0 0 1 .75-.75Zm-8.25.75a.75.75 0 0 1 1.5 0v5.5a.75.75 0 0 1-1.5 0ZM8 3a.75.75 0 0 1 .75.75v3.5a.75.75 0 0 1-1.5 0v-3.5A.75.75 0 0 1 8 3Z">
</path>
</svg>
</template>
<template id="pencil-icon">
<svg aria-hidden="true" height="16" viewBox="0 0 16 16" version="1.1" width="16" data-view-component="true" class="octicon octicon-pencil">
<path
d="M11.013 1.427a1.75 1.75 0 0 1 2.474 0l1.086 1.086a1.75 1.75 0 0 1 0 2.474l-8.61 8.61c-.21.21-.47.364-.756.445l-3.251.93a.75.75 0 0 1-.927-.928l.929-3.25c.081-.286.235-.547.445-.758l8.61-8.61Zm.176 4.823L9.75 4.81l-6.286 6.287a.253.253 0 0 0-.064.108l-.558 1.953 1.953-.558a.253.253 0 0 0 .108-.064Zm1.238-3.763a.25.25 0 0 0-.354 0L10.811 3.75l1.439 1.44 1.263-1.263a.25.25 0 0 0 0-.354Z">
</path>
</svg>
</template>
<template id="copilot-icon">
<svg aria-hidden="true" height="16" viewBox="0 0 16 16" version="1.1" width="16" data-view-component="true" class="octicon octicon-copilot">
<path
d="M7.998 15.035c-4.562 0-7.873-2.914-7.998-3.749V9.338c.085-.628.677-1.686 1.588-2.065.013-.07.024-.143.036-.218.029-.183.06-.384.126-.612-.201-.508-.254-1.084-.254-1.656 0-.87.128-1.769.693-2.484.579-.733 1.494-1.124 2.724-1.261 1.206-.134 2.262.034 2.944.765.05.053.096.108.139.165.044-.057.094-.112.143-.165.682-.731 1.738-.899 2.944-.765 1.23.137 2.145.528 2.724 1.261.566.715.693 1.614.693 2.484 0 .572-.053 1.148-.254 1.656.066.228.098.429.126.612.012.076.024.148.037.218.924.385 1.522 1.471 1.591 2.095v1.872c0 .766-3.351 3.795-8.002 3.795Zm0-1.485c2.28 0 4.584-1.11 5.002-1.433V7.862l-.023-.116c-.49.21-1.075.291-1.727.291-1.146 0-2.059-.327-2.71-.991A3.222 3.222 0 0 1 8 6.303a3.24 3.24 0 0 1-.544.743c-.65.664-1.563.991-2.71.991-.652 0-1.236-.081-1.727-.291l-.023.116v4.255c.419.323 2.722 1.433 5.002 1.433ZM6.762 2.83c-.193-.206-.637-.413-1.682-.297-1.019.113-1.479.404-1.713.7-.247.312-.369.789-.369 1.554 0 .793.129 1.171.308 1.371.162.181.519.379 1.442.379.853 0 1.339-.235 1.638-.54.315-.322.527-.827.617-1.553.117-.935-.037-1.395-.241-1.614Zm4.155-.297c-1.044-.116-1.488.091-1.681.297-.204.219-.359.679-.242 1.614.091.726.303 1.231.618 1.553.299.305.784.54 1.638.54.922 0 1.28-.198 1.442-.379.179-.2.308-.578.308-1.371 0-.765-.123-1.242-.37-1.554-.233-.296-.693-.587-1.713-.7Z">
</path>
<path d="M6.25 9.037a.75.75 0 0 1 .75.75v1.501a.75.75 0 0 1-1.5 0V9.787a.75.75 0 0 1 .75-.75Zm4.25.75v1.501a.75.75 0 0 1-1.5 0V9.787a.75.75 0 0 1 1.5 0Z"></path>
</svg>
</template>
<div class="position-relative">
<ul role="listbox" class="ActionListWrap QueryBuilder-ListWrap" aria-label="Suggestions" data-action="
combobox-commit:query-builder#comboboxCommit
mousedown:query-builder#resultsMousedown
" data-target="query-builder.resultsList" data-persist-list="false" id="query-builder-test-results"></ul>
</div>
<div class="FormControl-inlineValidation" id="validation-3d01b0da-fe0b-40f2-8300-cc079c15bb4c" hidden="hidden">
<span class="FormControl-inlineValidation--visual">
<svg aria-hidden="true" height="12" viewBox="0 0 12 12" version="1.1" width="12" data-view-component="true" class="octicon octicon-alert-fill">
<path d="M4.855.708c.5-.896 1.79-.896 2.29 0l4.675 8.351a1.312 1.312 0 0 1-1.146 1.954H1.33A1.313 1.313 0 0 1 .183 9.058ZM7 7V3H5v4Zm-1 3a1 1 0 1 0 0-2 1 1 0 0 0 0 2Z"></path>
</svg>
</span>
<span></span>
</div>
</div>
<div data-target="query-builder.screenReaderFeedback" aria-live="polite" aria-atomic="true" class="sr-only"></div>
</query-builder>
</form>
POST /search/feedback
<form id="code-search-feedback-form" data-turbo="false" action="/search/feedback" accept-charset="UTF-8" method="post"><input type="hidden" data-csrf="true" name="authenticity_token"
value="TApzOBMHWdCAWx1tQ2KWQi7pZ6SPKgR+10vLY17mGigFmy9mmNLgEHeTZy/8HGqlXQZseA4zFhIlVboJ1+/IVg==">
<p>We read every piece of feedback, and take your input very seriously.</p>
<textarea name="feedback" class="form-control width-full mb-2" style="height: 120px" id="feedback"></textarea>
<input name="include_email" id="include_email" aria-label="Include my email address so I can be contacted" class="form-control mr-2" type="checkbox">
<label for="include_email" style="font-weight: normal">Include my email address so I can be contacted</label>
</form>
POST /search/custom_scopes
<form id="custom-scopes-dialog-form" data-turbo="false" action="/search/custom_scopes" accept-charset="UTF-8" method="post"><input type="hidden" data-csrf="true" name="authenticity_token"
value="w28laFrcRchd4VlD3ukifZkUCbeZyhm460pEXis7mJS8u7NddQxQncZhDLOlAtChdl84n7bdd2aHWh7lkGyt7A==">
<div data-target="custom-scopes.customScopesModalDialogFlash"></div>
<input type="hidden" id="custom_scope_id" name="custom_scope_id" data-target="custom-scopes.customScopesIdField">
<div class="form-group">
<label for="custom_scope_name">Name</label>
<auto-check src="/search/custom_scopes/check_name" required="">
<input type="text" name="custom_scope_name" id="custom_scope_name" data-target="custom-scopes.customScopesNameField" class="form-control" autocomplete="off" placeholder="github-ruby" required="" maxlength="50" spellcheck="false">
<input type="hidden" data-csrf="true" value="tGzDZ8ncaXpA4eh35AwPx+QWO+skvR/zo3515grBRspd8Jej9WFbNG2tisFtrayzsUcWm/d+X6+cZpE2XLK9cg==">
</auto-check>
</div>
<div class="form-group">
<label for="custom_scope_query">Query</label>
<input type="text" name="custom_scope_query" id="custom_scope_query" data-target="custom-scopes.customScopesQueryField" class="form-control" autocomplete="off" placeholder="(repo:mona/a OR repo:mona/b) AND lang:python" required=""
maxlength="500">
</div>
<p class="text-small color-fg-muted"> To see all available qualifiers, see our <a class="Link--inTextBlock" href="https://docs.github.com/en/search-github/github-code-search/understanding-github-code-search-syntax">documentation</a>. </p>
</form>
Text Content
Skip to content Toggle navigation Sign in * Product * Actions Automate any workflow * Packages Host and manage packages * Security Find and fix vulnerabilities * Codespaces Instant dev environments * Copilot Write better code with AI * Code review Manage code changes * Issues Plan and track work * Discussions Collaborate outside of code Explore * All features * Documentation * GitHub Skills * Blog * Solutions For * Enterprise * Teams * Startups * Education By Solution * CI/CD & Automation * DevOps * DevSecOps Resources * Learning Pathways * White papers, Ebooks, Webinars * Customer Stories * Partners * Open Source * GitHub Sponsors Fund open source developers * The ReadME Project GitHub community articles Repositories * Topics * Trending * Collections * Pricing Search or jump to... SEARCH CODE, REPOSITORIES, USERS, ISSUES, PULL REQUESTS... Search Clear Search syntax tips PROVIDE FEEDBACK We read every piece of feedback, and take your input very seriously. Include my email address so I can be contacted Cancel Submit feedback SAVED SEARCHES USE SAVED SEARCHES TO FILTER YOUR RESULTS MORE QUICKLY Name Query To see all available qualifiers, see our documentation. Cancel Create saved search Sign in Sign up You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert {{ message }} tycrek / ass Public * Sponsor SPONSOR TYCREK/ASS * Notifications * Fork 58 * Star 548 The simple self-hosted ShareX server LICENSE ISC license 548 stars 58 forks Activity Star Notifications * Code * Issues 23 * Pull requests 3 * Actions * Wiki * Security * Insights Additional navigation options * Code * Issues * Pull requests * Actions * Wiki * Security * Insights TYCREK/ASS This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository. master Switch branches/tags Branches Tags Could not load branches Nothing to show {{ refName }} default View all branches Could not load tags Nothing to show {{ refName }} default View all tags NAME ALREADY IN USE A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch? Cancel Create 3 branches 42 tags Go to file Code * Local * Codespaces * Clone HTTPS GitHub CLI Use Git or checkout with SVN using the web URL. Work fast with our official CLI. Learn more about the CLI. * Open with GitHub Desktop * Download ZIP SIGN IN REQUIRED Please sign in to use Codespaces. LAUNCHING GITHUB DESKTOP If nothing happens, download GitHub Desktop and try again. LAUNCHING GITHUB DESKTOP If nothing happens, download GitHub Desktop and try again. LAUNCHING XCODE If nothing happens, download Xcode and try again. LAUNCHING VISUAL STUDIO CODE Your codespace will open once ready. There was a problem preparing your codespace, please try again. LATEST COMMIT tycrek π 0.14.8 π β¦ Loading status checksβ¦ 92a37a4 Nov 26, 2023 π 0.14.8 π 92a37a4 GIT STATS * 858 commits FILES Permalink Failed to load latest commit information. Type Name Latest commit message Commit time .github fix: copy changes from dev/0.15.0 branch October 14, 2023 13:04 gfycat moved all .js files into src/ & removed TLog socket plugin September 7, 2021 19:45 install Possibly this chain style works? June 15, 2022 16:25 src fix: display new users token after creation November 26, 2023 12:02 views fix: replace 'superior' with 'simple' π June 23, 2023 21:09 .gitignore chore: hide backup files December 7, 2022 15:59 Dockerfile fix: Dockerfile to reduce vulnerabilities August 17, 2023 02:02 LICENSE mode April 6, 2021 01:48 MagicNumbers.json fix: properly specify and use Magic Number HTTP codes December 26, 2022 15:19 compose.yaml Added note to Compose file about specification compliance July 12, 2022 15:55 flameshot_example.sh better error handling for rm and curl (#104) February 7, 2022 20:45 package-lock.json π 0.14.8 π November 26, 2023 12:04 package.json π 0.14.8 π November 26, 2023 12:04 sample_config.sxcu Updated sample and README to match ShareX v14 formatting July 13, 2022 16:53 tailwind.config.js style: make txtSecondary darker December 24, 2022 19:12 tailwind.css fix: added missing link variable to Tailwind theme December 24, 2022 19:12 tsconfig.json build: target ES2022 December 7, 2022 15:59 View code Notice (Sep 2023) Developers 𧑠Code quality Features For users For hosts & developers Access types Installation Docker Install using docker-compose What is this script doing? How do I run the npm scripts? How do I update? What else should I be aware of? Local Using HTTPS Cloudflare users Configure ShareX Header overrides Fancy embeds Embed placeholders Server-side embed configuration Webhooks Customizing the viewer Custom index Custom index code samples Custom 404 page File storage Local S3 New user system (v0.14.0) Adding users CLI Developer API API endpoints Custom frontends - OUTDATED Data Engines npm scripts Flameshot users (Linux) Contributing Credits README.MD ass is a self-hosted ShareX upload server written in Node.js. I initially started this project purely out of spite. ass aims to be as unopinionated as possible, giving users & hosts alike the ability to modify nearly everything. By default, ass comes with a resource viewing page, which includes metadata about the resource as well as a download button & inline viewers for images, videos, & audio. It does not have a user dashboard or registration system: this is intentional! Developers are free to create their own frontends using the languages & tools they are most comfortable with. Writing & using these frontends is fully documented below, in the wiki, & in the source code. NOTICE (SEP 2023) The current release version 0.14.x is now in maintenence mode. What this means is I'll only be providing updates to catastrophic issues. However! I'm currently working on a new version, 0.15.0, which is a lot more stable and organized. I have no ETA but please know that I'm continuing to work on it when I can. Version 0.14.x is still functional, just a bit rough around the edges. DEVELOPERS 𧑠ass was designed with developers in mind. If you are a developer & want something changed to better suit you, let me know & we'll see what we can do! CODE QUALITY CodeQL DeepSource FEATURES FOR USERS * Upload images, gifs, videos, audio, & files * Token-based authentication * Download & delete resources * GPS data automatically removed * Fully customizable Discord embeds * Built-in web viewer with video & audio player * Embed images, gifs, & videos directly in Discord * Personal upload log using customizable Discord Webhooks * macOS/Linux support with alternative clients such as Flameshot (script for ass) & MagicCap * Multiple URL styles * ZWS * Mixed-case alphanumeric * Gfycat * Original * Timestamp FOR HOSTS & DEVELOPERS * Usage metrics * Thumbnail support * Mimetype blocking * Themeable viewer page * Basic multi-user support * Configurable global upload size limit (per-user coming soon) * Custom pluggable frontends using Git Submodules * Run locally or in a Docker container * Multiple file storage methods * Local file system * Amazon S3, including DigitalOcean Spaces (more coming soon) * Multiple data storage methods using data engines * File * JSON (default, papito) * YAML (soon) * Database * PostgreSQL (ass-psql) * MongoDB (ass-mongoose) * MySQL (soon) ACCESS TYPES Type What is it? Zero-width spaces When pasted elsewhere, the URL appears to be just your domain name. Some browsers or sites may not recognize these URLs (Discord sadly no longer supports these as of April 2023) Mixed-case alphanumeric The "safe" mode. URL's are browser safe as the character set is just letters & numbers. Gfycat Gfycat-style ID's (for example: https://example.com/unsung-discrete-grub). Thanks to Gfycat for the wordlists Original The "basic" mode. URL matches the same filename as when the file was uploaded. This may be prone to conflicts with files of the same name. Timestamp The quick but dirty mode. URL is a timestamp of when the file was uploaded, in milliseconds. This is the most unique mode, but also potentially the longest (Gfycat could be longer, easily). Keep in mind this is vulnerable to iteration attacks INSTALLATION ass supports two installation methods: Docker (recommended) & local (manual). DOCKER Expand for Docker/Docker Compose installation steps Docker Compose is the recommended way to install ass. These steps assume you are already family with Docker. If not, you should probably use the local installation method. They also assume that you have a working Docker installation with Docker Compose v2 installed. INSTALL USING DOCKER-COMPOSE 1. Clone the ass repo using git clone https://github.com/tycrek/ass.git && cd ass/ 2. Run the command that corresponds to your OS: * Linux: ./install/docker-linux.sh (uses #!/bin/bash) * Windows: install\docker-windows.bat (from Command Prompt) * These scripts are identical using the equivalent commands in each OS. 3. Work through the setup process when prompted. The upload token will be printed at the end of the setup script prompts. This is the token that you'll need to use to upload resources to ass. It may go by too quickly to copy it, so just scroll back up in your terminal after setup or run cat auth.json. You should now be able to access the ass server at http://localhost:40115/ (ass-docker will bind to host 0.0.0.0 to allow external access). You can configure a reverse proxy (for example, Caddy; also check out [my tutorial]) to make it accessible from the internet with automatic SSL. WHAT IS THIS SCRIPT DOING? It creates directories & files required for Docker Compose to properly set up volumes. After that, it simply builds the image & container, then launches the setup process. HOW DO I RUN THE NPM SCRIPTS? Since all 3 primary data files are bound to the container with Volumes, you can run the scripts in two ways: docker compose exec or npm on the host. # Check the usage metrics docker compose exec ass npm run metrics # Run the setup script docker compose exec ass npm run setup && docker compose restart # Run npm on the host to run the setup script (also works for metrics) # (You will have to meet the Node.js & npm requirements on your host for this to work properly) npm run setup && docker compose restart HOW DO I UPDATE? Easy! Just pull the changes & run this one-liner: # Pull the latest version of ass & rebuild the image git pull && docker compose build --no-cache && docker compose up -d WHAT ELSE SHOULD I BE AWARE OF? Deploying ass with Docker exposes five volumes. These volumes let you edit the config, view the auth or data files, or view the uploads/ folder from your host. * uploads/ * share/ * config.json * auth.json * data.json LOCAL Expand for local installation steps 1. You should have Node.js 16 & npm 8 or later installed. 2. Clone this repo using git clone https://github.com/tycrek/ass.git && cd ass/ 3. Run npm i --save-dev to install the required dependencies (--save-dev is required for compilation) 4. Run npm run build to compile the TypeScript files 5. Run npm start to start ass. The first time you run ass, the setup process will automatically be called & you will be shown your first authorization token; save this as you will need it to configure ShareX. USING HTTPS For HTTPS support, you must configure a reverse proxy. I recommend Caddy but any reverse proxy works fine (such as Apache or Nginx). A sample config for Caddy is provided below: ass.example.com { reverse_proxy localhost:40115 } CLOUDFLARE USERS In your Cloudflare DNS dashboard, set your domain/subdomain to DNS Only if you experience issues with Proxied. This may not be necessary for all users. > CONFIGURE SHAREX 1. Add a new Custom Uploader in ShareX by going to Destinations > Custom uploader settings... 2. Under Uploaders, click New & name it whatever you like. 3. Set Destination type to Image, Text, & File 4. Request tab: * Method: POST * URL: https://your.domain.name.here/ * Body: Form data (multipart/form-data) * File from name: file (literally put "file" in the field) * Headers: * Name: Authorization * Value: (the value provided by npm start on first run) 5. Response tab: * URL: {json:.resource} * Thumbnail: {json:.thumbnail} * Deletion URL: {json:.delete} * Error message: {response} * MagicCap users: do not include the . in the above & replace {} with $ (i.e. $json:resource$) 6. The file sample_config.sxcu can also be modified & imported to suit your needs HEADER OVERRIDES If you need to override a specific part of the config to be different from the global config, you may do so via "X" HTTP headers: Header Purpose X-Ass-Domain Override the domain returned for the clipboard (useful for multi-domain hosts) X-Ass-Access Override the generator used for the resource URL. Must be one of: original, zws, gfycat, random, or timestamp (see above) X-Ass-Gfycat Override the length of Gfycat ID's. Defaults to 2 X-Ass-Timeoffset Override the timestamp offset. Defaults to UTC+0. Available options are whatever Luxon accepts (for example: America/Edmonton or UTC-7) FANCY EMBEDS If you primarily share media on Discord, you can add these additional (optional) headers to build embeds: Header Purpose X-Ass-OG-Title Large text shown above your media. Required for embeds to appear on desktop. X-Ass-OG-Description Small text shown below the title but above the media (does not show up on videos) X-Ass-OG-Author Small text shown above the title X-Ass-OG-Author-Url URL to open when the Author is clicked X-Ass-OG-Provider Smaller text shown above the author X-Ass-OG-Provider-Url URL to open when the Provider is clicked X-Ass-OG-Color Colour shown on the left side of the embed. Must be one of &random, &vibrant, or a hex colour value (for example: #fe3c29). Random is a randomly generated hex value & Vibrant is sourced from the image itself EMBED PLACEHOLDERS You can insert certain metadata into your embeds with these placeholders: Placeholder Result &size The files size with proper notation rounded to two decimals (example: 7.06 KB) &filename The original filename of the uploaded file ×tamp The timestamp of when the file was uploaded (example: Oct 14, 1983, 1:30 PM) SERVER-SIDE EMBED CONFIGURATION You may also specify a default embed config on the server. Keep in mind that if users specify the X-Ass-OG-Title header, the server-side config will be ignored. To configure the server-side embed, create a new file in the share/ directory named embed.json. Available options are: * title * description * author * authorUrl * provider * providerUrl * color Their values are equivalent to the headers listed above. WEBHOOKS You may use Discord webhooks as an easy way to keep track of your uploads. The first step is to create a new Webhook. You only need to follow the first section, Making a Webhook. Once you are done that, click Copy Webhook URL. Finally, add these headers to your custom uploader: Header Purpose X-Ass-Webhook-Url The Webhook URL you copied X-Ass-Webhook-Username (Optional) the "username" of the Webhook; can be set to whatever you want X-Ass-Webhook-Avatar (Optional) URL to an image to use as the Webhook avatar. Use the full URL including https:// Webhooks will show the filename, mimetype, size, upload timestamp, thumbail, & a link to delete the file. To disable webhooks, simply remove the headers from your config. CUSTOMIZING THE VIEWER If you want to customize the font or colours of the viewer page, create a file in the share/ directory called theme.json. Available options are: Option Purpose font The font family to use; defaults to "Josefin Sans". Fonts with a space should be surrounded by double quotes. bgPage Background colour for the whole page bgViewer Background colour for the viewer element txtPrimary Primary text colour; this should be your main brand colour. txtSecondary Secondary text colour; this is used for the file details. linkPrimary Primary link colour linkHover Colour of the hover effect for links linkActive Colour of the active effect for links borderHover Colour of the hover effect for borders; this is used for the underlining links. CUSTOM INDEX By default, ass directs the index route / to this README. Follow these steps to use a custom index: 1. Create a file in the share/ directory called index.html or index.js. * ass will treat index.html as an HTML file and will send it to the client. * ass will treat index.js as a Node.js file that exports a function representing Express middleware. ass will pass all handling of the index to this function. The function should take three arguments: (req, res, next). Some code samples for common use cases are provided below. * If both index.html and index.js are present, the index.html file will be served first. 2. Add whatever you want to the file. 3. Restart ass. The startup info logs should mention which file is being used as the index. CUSTOM INDEX CODE SAMPLES Redirect to a custom frontend registration page module.exports = (req, res, next) => res.redirect('/register'); CUSTOM 404 PAGE To use a custom 404 page, create a file in the share/ directory called 404.html. Restart ass, and any requests to missing resources will return HTTP 404 with the contents of this file. If there's interest, I may allow making this a function, similar to the custom index. FILE STORAGE ass supports three methods of file storage: local, S3, or [Skynet]. LOCAL Local storage is the simplest option, but relies on you having a lot of disk space to store files, which can be costly. S3 Any existing object storage server that's compatible with [Amazon S3] can be used with ass. I personally host my files using Digital Ocean Spaces, which implements S3. S3 servers are generally very fast & have very good uptime, though this will depend on the hosting provider & plan you choose. NEW USER SYSTEM (V0.14.0) The user system was overhauled in v0.14.0 to allow more features and flexibility. New fields on users include admin, passhash, unid, and meta (these will be documented more once the system is finalized). New installs will automatically generate a default user. Check the auth.json file for the token. You will use this for API requests and to authenticate within ShareX. ass will automatically convert your old auth.json to the new format. Always backup your auth.json and data.json before updating. By default, the original user (named ass) will be marked as an admin. ADDING USERS You may add users via the CLI or the API. I'll document the API further in the future. CLI npm run cli-adduser <username> <password> [admin] [meta] Argument Purpose username string The username of the user. password string The password of the user. admin? boolean Whether the user is an admin. Defaults to false. meta? string Any additional metadata to store on the user, as a JSON string. Things still not added: * Modifying/deleting users via the API DEVELOPER API ass includes an API (v0.14.0) for frontend developers to easily integrate with. Right now the API is pretty limited but I will expand on it in the future, with frontend developer feedback. Any endpoints requiring authorization will require an Authorization header with the value being the user's upload token. Admin users are a new feature introduced in v0.14.0. Admin users can access all endpoints, while non-admin users can only access those relevant to them. Other things to note: * All endpoints are prefixed with /api/. * All endpoints will return a JSON object unless otherwise specified. * Successful endpoints should return a 200 status code. Any errors will use the corresponding 4xx or 5xx status code (such as 401 Unauthorized). * ass's API will try to be as compliant with the HTTP spec as possible. For example, using POST/PUT for create/modify, and response codes such as 409 Conflict for duplicate entries. This compliance may not be 100% perfect, but I will try my best. API ENDPOINTS Endpoint Purpose Admin? GET /user/ Returns a list of all users Yes GET /user/:id Returns the user with the given ID Yes GET /user/self Returns the current user No GET /user/token/:token Returns the user with the given token No POST /user/ Creates a new user. Request body must be a JSON object including username and password. You may optionally include admin (boolean) or meta (object). Returns 400 if fails. Yes POST /user/password/reset/:id Force resets the user's password. Request body must be a JSON object including a password. Yes DELETE /user/:id Deletes the user with the given ID, as well as all their uploads. Yes PUT /user/meta/:id Updates the user's metadata. Request body must be a JSON object with keys key and value, with the key/value you want to set in the users metadata. Optionally you may include force: boolean to override existing keys. Yes DELETE /user/meta/:id Deletes a key/value from a users metadata. Request body must be a JSON object with a key property specifying the key to delete. Yes PUT /user/username/:id Updates the user's username. Request body must be a JSON object with a username property. Yes PUT /user/token/:id Regenerates a users upload token Yes CUSTOM FRONTENDS - OUTDATED Please be aware that this section is outdated (marked as of 2022-04-15). It will be updated when I overhaul the frontend system. Update 2022-12-24: I plan to overhaul this early in 2023. ass is intended to provide a strong backend for developers to build their own frontends around. Git Submodules make it easy to create custom frontends. Submodules are their own projects, which means you are free to build the router however you wish, as long as it exports the required items. A custom frontend is really just an Express.js router. For a detailed walkthrough on developing your first frontend, consult the wiki. DATA ENGINES Papito data engines are responsible for managing your data. "Data" has two parts: an identifier & the actual data itself. With ass, the data is a JSON object representing the uploaded resource. The identifier is the unique ID in the URL returned to the user on upload. Update August 2022: I plan to overhaul Papito and how all this works eventually. If this comment is still here in a year, kick message me. Supported data engines: Name Description Links JSON JSON-based data storage. On disk, data is stored in a JSON file. In memory, data is stored in a Map. This is the default engine. GitHub npm PostgreSQL Data storage using a PostgreSQL database. node-postgres is used for communicating with the database. GitHub npm Mongoose Data storage using a MongoDB database. mongoose is used for communicating with the database. Created by @dylancl GitHub npm A Papito data engine implements support for one type of database (or file, such as JSON or YAML). This lets ass server hosts pick their database of choice, because all they'll have to do is enter the connection/authentication details & ass will handle the rest, using the resource ID as the key. For a detailed walkthrough on developing engines, consult the wiki. Outdated! NPM SCRIPTS ass has a number of pre-made npm scripts for you to use. All of these scripts should be run using npm run <script-name> (except start). Script Description start Starts the ass server. This is the default script & is run with npm start. build Compiles the TypeScript files into JavaScript. dev Chains the build & compile scripts together. setup Starts the easy setup process. Should be run after any updates that introduce new config options. metrics Runs the metrics script. This is a simple script that outputs basic resource statistics. purge Purges all uploads & data associated with them. This does not delete any users, however. engine-check Ensures your environment meets the minimum Node & npm version requirements. FLAMESHOT USERS (LINUX) Use this script. For the KEY, put your token. Thanks to @ToxicAven for creating this! CONTRIBUTING Please follow the Contributing Guidelines when submiting Issues or Pull Requests. CREDITS * Thanks to hlsl#1359 for the logo * Gfycat for their wordlists * Aven, for helping kickstart the project * My spiteful ass for motivating me to actually take this project to new heights ABOUT The simple self-hosted ShareX server TOPICS docker docker-compose discord embeds self-hosted sharex sharex-server sharex-uploader RESOURCES Readme LICENSE ISC license Activity STARS 548 stars WATCHERS 9 watching FORKS 58 forks Report repository RELEASES 42 π 0.14.8 π Latest Nov 26, 2023 + 41 releases SPONSOR THIS PROJECT * ko-fi.com/tycrek CONTRIBUTORS 15 * * * * * * * * * * * * * * LANGUAGES * TypeScript 72.1% * JavaScript 18.8% * Pug 3.1% * Shell 2.3% * CSS 2.0% * Batchfile 1.0% * Dockerfile 0.7% FOOTER Β© 2023 GitHub, Inc. FOOTER NAVIGATION * Terms * Privacy * Security * Status * Docs * Contact * Manage cookiesDo not share my personal information You canβt perform that action at this time.