mirror of
https://github.com/freedombox/FreedomBox.git
synced 2026-07-01 11:31:28 +00:00
7bd9b61cac
Signed-off-by: James Valleroy <jvalleroy@mailbox.org> Reviewed-by: Sunil Mohan Adapa <sunil@medhas.org>
2 lines
13 KiB
XML
2 lines
13 KiB
XML
<?xml version="1.0" encoding="utf-8"?><!DOCTYPE article PUBLIC '-//OASIS//DTD DocBook XML V4.4//EN' 'http://www.docbook.org/xml/4.4/docbookx.dtd'><article><articleinfo><title>FreedomBox/Manual/bepasty</title><revhistory><revision><revnumber>10</revnumber><date>2020-08-19 05:23:17</date><authorinitials>SunilMohanAdapa</authorinitials><revremark>Add 'Snippet' in the short description</revremark></revision><revision><revnumber>9</revnumber><date>2020-08-19 05:22:39</date><authorinitials>SunilMohanAdapa</authorinitials><revremark>Expand the description of the app</revremark></revision><revision><revnumber>8</revnumber><date>2020-08-18 18:21:34</date><authorinitials>fioddor</authorinitials><revremark>Main title case standardized.</revremark></revision><revision><revnumber>7</revnumber><date>2020-08-15 13:01:05</date><authorinitials>JamesValleroy</authorinitials><revremark>fix screenshot size</revremark></revision><revision><revnumber>6</revnumber><date>2020-08-15 12:01:07</date><authorinitials>JamesValleroy</authorinitials><revremark>add screenshot</revremark></revision><revision><revnumber>5</revnumber><date>2020-08-15 11:51:00</date><authorinitials>JamesValleroy</authorinitials><revremark>describe managing passwords</revremark></revision><revision><revnumber>4</revnumber><date>2020-08-15 11:42:36</date><authorinitials>JamesValleroy</authorinitials><revremark>describe using bepasty</revremark></revision><revision><revnumber>3</revnumber><date>2020-08-15 11:33:20</date><authorinitials>JamesValleroy</authorinitials><revremark>describe distributing passwords</revremark></revision><revision><revnumber>2</revnumber><date>2020-08-15 11:27:46</date><authorinitials>JamesValleroy</authorinitials><revremark>describe passwords and permissions</revremark></revision><revision><revnumber>1</revnumber><date>2020-08-09 00:54:01</date><authorinitials>JamesValleroy</authorinitials><revremark>add stub page for bepasty</revremark></revision></revhistory></articleinfo><para><!--"~-smaller-~" is not applicable to DocBook--><ulink url="https://wiki.debian.org/FreedomBox/Manual/bepasty/DebianWiki/EditorGuide#translation">Translation(s)</ulink>: English - <ulink url="https://wiki.debian.org/FreedomBox/Manual/bepasty/es/FreedomBox/Manual/bepasty#">Español</ulink> </para><section><title>Bepasty (File & Snippet Sharing)</title><informaltable><tgroup cols="1"><colspec colname="col_0"/><tbody><row rowsep="1"><entry colsep="1" rowsep="1"><para> <inlinemediaobject><imageobject><imagedata fileref="https://wiki.debian.org/FreedomBox/Manual/bepasty?action=AttachFile&do=get&target=bepasty-icon_en_V01.png"/></imageobject><textobject><phrase>bepasty icon</phrase></textobject></inlinemediaobject> </para></entry></row></tbody></tgroup></informaltable><para><emphasis role="strong">Available since</emphasis>: version 20.14 </para><section><title>What is bepasty?</title><para>bepasty is a web application that allows large files to be uploaded and shared. Text and code snippets can also be pasted and shared. Text, image, audio, video and PDF documents can be previewed in the browser. Shared files can be set to expire after a time period. </para></section><section><title>Screenshot</title><para><inlinemediaobject><imageobject><imagedata fileref="https://wiki.debian.org/FreedomBox/Manual/bepasty?action=AttachFile&do=get&target=bepasty_logged_in_page.png" width="800"/></imageobject><textobject><phrase>Screenshot of bepasty</phrase></textobject></inlinemediaobject> </para></section><section><title>Passwords and Permissions</title><para>bepasty uses only passwords (without usernames) to control access. Depending on which password is used to login to bepasty, the user will have different permissions. They can have any combination of the following permissions: </para><itemizedlist><listitem><para><emphasis role="strong">read</emphasis>: Read a file, if they know the URL. </para></listitem><listitem><para><emphasis role="strong">list</emphasis>: List all files. </para></listitem><listitem><para><emphasis role="strong">create</emphasis>: Paste or upload a new file. </para></listitem><listitem><para><emphasis role="strong">delete</emphasis>: Delete a file. </para></listitem><listitem><para><emphasis role="strong">admin</emphasis>: Can lock and unlock files. </para></listitem></itemizedlist><para>After bepasty is installed, it comes pre-configured for the following roles: </para><itemizedlist><listitem><para>Viewer: can view and list files </para></listitem><listitem><para>Editor: can view, list, create, and delete files </para></listitem><listitem><para>Administrator: has all permissions </para></listitem></itemizedlist><para>These roles support a use-case of file sharing between known, authorized users. If needed, you can re-configure bepasty to support other roles and use-cases. </para></section><section><title>Distributing passwords</title><para>By default, the Public Access configuration is set to <emphasis>None</emphasis>, so a password is required for any use of bepasty. This means that you will need to distribute the passwords to the appropriate users, through any communication channels that you have. </para><para>Note that you may want to create multiple passwords with the same permissions. This allows you to distribute a unique password to each user (or to a group of users). Then if you want to revoke access to one user, you can simply delete their password. The other users with their own passwords will not be affected. </para></section><section><title>Using bepasty</title><para>After logging in to bepasty, if you have the Create permission, you will see a large text box where you can paste any text. Optionally, you can provide a filename or Content-Type for the data. After clicking Submit, the file is created. </para><para>You can also drag and drop files in the area at the bottom. They are uploaded immediate after dropping them in this area. You can also create a list to track a collection of uploaded files. </para><para>For either case, you can set a maximum lifetime value. After this time expires, the file will be deleted. </para><para>If you have the List permission, then you will see a link <emphasis>List all Items</emphasis> at the top of the page. This will show all files that have been created or uploaded. </para><para>If you have the Delete or Admin permission, you will see extra actions shown next to each file on the list page. </para><para>If you only have the Read permission, then to read files, you will need to have both a password and one or more URLs for existing files. </para></section><section><title>Managing passwords</title><para>The bepasty configuration page in FreedomBox interface allows you to create new passwords, or to remove a password. When you create a password, you can choose any combination of the permissions described above. Note that a typical Administrator should have all of the permissions (not just "Admin"). </para><para>You can also set a Comment. This is recommended, and you should use the comment to help yourself remember the purpose of the password, or who will be using the password. </para><para>You can also configure Public Access, which sets the default permissions that are available even without logging in with a password. You can set this to allow reading files by their URL, or reading and listing all files. </para></section><section><title>External links</title><para><ulink url="https://bepasty-server.readthedocs.io/en/latest/user.html"/> </para><para>Back to <ulink url="https://wiki.debian.org/FreedomBox/Manual/bepasty/FreedomBox/Features#">Features introduction</ulink> or <ulink url="https://wiki.debian.org/FreedomBox/Manual/bepasty/FreedomBox/Manual#">manual</ulink> pages. </para><!--rule (<hr>) is not applicable to DocBook--><informaltable><tgroup cols="8"><colspec colname="col_0"/><colspec colname="col_1"/><colspec colname="col_2"/><colspec colname="col_3"/><colspec colname="col_4"/><colspec colname="col_5"/><colspec colname="col_6"/><colspec colname="col_7"/><tbody><row rowsep="1"><entry colsep="1" rowsep="1"><para><emphasis role="strong">Information</emphasis></para></entry><entry colsep="1" rowsep="1"/><entry colsep="1" rowsep="1"/><entry colsep="1" rowsep="1"><para><emphasis role="strong">Support</emphasis></para></entry><entry colsep="1" rowsep="1"><para><emphasis role="strong">Contribute</emphasis></para></entry><entry colsep="1" rowsep="1"/><entry colsep="1" rowsep="1"><para><emphasis role="strong">Reports</emphasis></para></entry><entry colsep="1" rowsep="1"><para><emphasis role="strong">Promote</emphasis></para></entry></row><row rowsep="1"><entry colsep="1" rowsep="1"><para><ulink url="https://wiki.debian.org/FreedomBox/Manual/bepasty/FreedomBox/Introduction#">Overview</ulink> </para></entry><entry colsep="1" rowsep="1"><para><ulink url="https://wiki.debian.org/FreedomBox/Manual/bepasty/FreedomBox/Hardware#">Hardware</ulink> </para></entry><entry colsep="1" rowsep="1"><para><emphasis role="strong"> </emphasis></para></entry><entry colsep="1" rowsep="1"><para><ulink url="https://wiki.debian.org/FreedomBox/Manual/bepasty/FreedomBox/Support#">Live Help</ulink> </para></entry><entry colsep="1" rowsep="1"><para><ulink url="https://wiki.debian.org/FreedomBox/Manual/bepasty/FreedomBox/Contribute#">Where To Start</ulink> </para></entry><entry colsep="1" rowsep="1"><para><ulink url="https://wiki.debian.org/FreedomBox/Manual/bepasty/FreedomBox/Translate#">Translate</ulink> </para></entry><entry colsep="1" rowsep="1"><para><ulink url="https://wiki.debian.org/FreedomBox/Manual/bepasty/FreedomBox/ProgressCalls#">Calls</ulink> </para></entry><entry colsep="1" rowsep="1"><para><ulink url="https://wiki.debian.org/FreedomBox/Manual/bepasty/FreedomBox/TalksAndPresentations#">Talks</ulink> </para></entry></row><row rowsep="1"><entry colsep="1" rowsep="1"><para><ulink url="https://wiki.debian.org/FreedomBox/Manual/bepasty/FreedomBox/Features#">Features</ulink> </para></entry><entry colsep="1" rowsep="1"><para><ulink url="https://wiki.debian.org/FreedomBox/Manual/bepasty/FreedomBox/Vision#">Vision</ulink> </para></entry><entry colsep="1" rowsep="1"><para><emphasis role="strong"> </emphasis></para></entry><entry colsep="1" rowsep="1"><para><ulink url="https://wiki.debian.org/FreedomBox/Manual/bepasty/FreedomBox/QuestionsAndAnswers#">Q&A</ulink> </para></entry><entry colsep="1" rowsep="1"><para><ulink url="https://wiki.debian.org/FreedomBox/Manual/bepasty/FreedomBox/Design#">Design</ulink> </para></entry><entry colsep="1" rowsep="1"><para><ulink url="https://wiki.debian.org/FreedomBox/Manual/bepasty/FreedomBox/TODO#">To Do</ulink> </para></entry><entry colsep="1" rowsep="1"><para><ulink url="https://wiki.debian.org/FreedomBox/Manual/bepasty/FreedomBox/ReleaseNotes#">Releases</ulink> </para></entry><entry colsep="1" rowsep="1"><para><ulink url="https://wiki.debian.org/FreedomBox/Manual/bepasty/FreedomBox/Press#">Press</ulink> </para></entry></row><row rowsep="1"><entry colsep="1" rowsep="1"><para><ulink url="https://wiki.debian.org/FreedomBox/Manual/bepasty/FreedomBox/Download#">Download</ulink> </para></entry><entry colsep="1" rowsep="1"><para><ulink url="https://wiki.debian.org/FreedomBox/Manual/bepasty/FreedomBox/Manual#">Manual</ulink> </para></entry><entry colsep="1" rowsep="1"><para><emphasis role="strong"> </emphasis></para></entry><entry colsep="1" rowsep="1"/><entry colsep="1" rowsep="1"><para><ulink url="https://wiki.debian.org/FreedomBox/Manual/bepasty/FreedomBox/Contribute/Code#">Code</ulink> </para></entry><entry colsep="1" rowsep="1"><para><ulink url="https://wiki.debian.org/FreedomBox/Manual/bepasty/FreedomBox/Contributors#">Contributors</ulink> </para></entry><entry colsep="1" rowsep="1"/><entry colsep="1" rowsep="1"><para><ulink url="https://wiki.debian.org/FreedomBox/Manual/bepasty/FreedomBox/Blog#">Blog</ulink> </para></entry></row><row rowsep="1"><entry colsep="1" nameend="col_1" namest="col_0" rowsep="1"><para> <ulink url="https://en.wikibooks.org/wiki/FreedomBox_for_Communities">FreedomBox for Communities</ulink> </para></entry><entry colsep="1" rowsep="1"/><entry colsep="1" rowsep="1"/><entry colsep="1" nameend="col_5" namest="col_4" rowsep="1"><para> <ulink url="https://docs.freedombox.org">FreedomBox Developer Manual</ulink> </para></entry><entry colsep="1" rowsep="1"/><entry colsep="1" rowsep="1"/></row></tbody></tgroup></informaltable><para><!--"~-smaller-~" is not applicable to DocBook-->HELP & DISCUSSIONS: <ulink url="https://discuss.freedombox.org">Discussion Forum</ulink> - <ulink url="https://lists.alioth.debian.org/mailman/listinfo/freedombox-discuss">Mailing List</ulink> - <ulink url="irc://irc.debian.org/freedombox">#freedombox irc.debian.org</ulink> | CONTACT <ulink url="https://freedomboxfoundation.org/">Foundation</ulink> | JOIN <ulink url="https://salsa.debian.org/freedombox-team/">Project</ulink> </para><para><link linkend="">Next call</link>: Sunday, August 23rd at 17:00 UTC </para><para><link linkend="">Latest news</link>: Help translate freedombox.org - 2020-08-01 </para><para>This page is copyright its contributors and is licensed under the <ulink url="https://creativecommons.org/licenses/by-sa/4.0/">Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0)</ulink> license. </para><!--rule (<hr>) is not applicable to DocBook--><para> <ulink url="https://wiki.debian.org/FreedomBox/Manual/bepasty/CategoryFreedomBox#">CategoryFreedomBox</ulink> </para></section></section></article>
|