briar issueshttps://code.briarproject.org/groups/briar/-/issues2023-08-28T16:00:10Zhttps://code.briarproject.org/briar/briar-mailbox/-/issues/194Documentation forthcoming?2023-08-28T16:00:10Zcoreless corelessDocumentation forthcoming?Will there be documentation added to the wiki about administering Briar Mailbox?
Perhaps I am mistaken, but the version number (1.0.5) implies Briar Mailbox is considered stable and fit for production use? If so, I'd like to deploy it ...Will there be documentation added to the wiki about administering Briar Mailbox?
Perhaps I am mistaken, but the version number (1.0.5) implies Briar Mailbox is considered stable and fit for production use? If so, I'd like to deploy it for my own use as well as my community, but I would benefit from documentation about how to do so.https://code.briarproject.org/briar/briar-spec/-/issues/19Provide test cases as part of specification2023-02-14T22:34:30ZNicoProvide test cases as part of specificationWhen implementing Briar from the specifications in this project, test cases could be useful that allow developers to confirm that their implementations do what they are supposed to do. Some examples:
* given some briar:// link, confirm t...When implementing Briar from the specifications in this project, test cases could be useful that allow developers to confirm that their implementations do what they are supposed to do. Some examples:
* given some briar:// link, confirm that the right byte array including key and version is decoded
* given some public key (as byte array), confirm that the right briar:// link is generated
* given two briar:// links (and one of their private keys), confirm that the correct Tor Hidden Service .onion addresses are derived as part of BRP
I vaguely remember that test cases like those exist for other protocols or specifications. However, I'm not sure if the specifications are the right place to provide them or if there should rather be some sort of "test suite" that allows to test implementations regardless of their programming language.
As part of this issue, I'll link to places where tests like this are done in either briar-java or briar-rust.
### briar-java
* [KeyAgreementTest](https://code.briarproject.org/briar/briar/-/blob/release-1.4.20/bramble-core/src/test/java/org/briarproject/bramble/crypto/KeyAgreementTest.java)
### briar-rust
### References
* [Test vector in Elliptic Curve RFC 7748](https://www.rfc-editor.org/rfc/rfc7748#section-6.1)https://code.briarproject.org/briar/website/-/issues/32Public roadmap2021-02-17T01:04:47ZakwizgranPublic roadmapUser feedback: "It would be nice if your web site listed planned versions and added features so users could know what capabilities are in the pipeline."
The closest we currently have is this:
https://code.briarproject.org/briar/briar/w...User feedback: "It would be nice if your web site listed planned versions and added features so users could know what capabilities are in the pipeline."
The closest we currently have is this:
https://code.briarproject.org/briar/briar/wikis/product-backlogCleopatraCleopatrahttps://code.briarproject.org/briar/website/-/issues/31Design brochure2021-01-31T05:07:50ZCleopatraDesign brochureIt'll be nice to have a brochure that can be printed and handed out at events.
**Size:** 8.5 x 5.5 inches
We could have 2 versions of the brochure, with the same front and different backs:
- **Freedom & Privacy Online:** The target au...It'll be nice to have a brochure that can be printed and handed out at events.
**Size:** 8.5 x 5.5 inches
We could have 2 versions of the brochure, with the same front and different backs:
- **Freedom & Privacy Online:** The target audience here is the general public - helping educate people about the reasons that protecting their privacy is important.
- **Activist & aid workers:** This is meant for activists and people working in disaster response - showing people how they can use Briar to communicate when the internet is not available.
**Front content:**
- Briar's mission
- Link to learn more
- How to contribute to the project
- Briar's main features
- How to download
**Back content:**
- Who uses Briar
- Main features
- Use cases
- How Briar workshttps://code.briarproject.org/briar/briar-manual/-/issues/6Table of contents is incomplete2020-12-21T12:10:31ZakwizgranTable of contents is incompleteSome sections of the manual are missing from the table of contents sidebar.Some sections of the manual are missing from the table of contents sidebar.CleopatraCleopatrahttps://code.briarproject.org/briar/website/-/issues/29Expand FAQs2022-11-18T17:32:17ZCleopatraExpand FAQsSubtask of #28
```
- What is Briar?
- How does Briar work?
- Why is it called Briar?
- How is Briar different from other messaging apps?
- How do I install/update/uninstall Briar?
- What platforms can I use Briar on?
- Can I send files ...Subtask of #28
```
- What is Briar?
- How does Briar work?
- Why is it called Briar?
- How is Briar different from other messaging apps?
- How do I install/update/uninstall Briar?
- What platforms can I use Briar on?
- Can I send files and images?
- Can I do video calls?
- Why is Briar is always logged out every time I open the app?
- What is the difference between a forum, private group and blog?
- What does Briar use for end2end encryption
- How are messages delivered?
- Why is my connection to a private group so slow?
- What happens to abandoned accounts?
- Why does Briar drain more battery?
- What are some limitations of Briar?
- how can briar sync over the internet without a server? how do you know where to send the sync to? don't you need some kind of known address or middleman to sync?
```CleopatraCleopatrahttps://code.briarproject.org/briar/briar-manual/-/issues/5Prepare manual for translation2020-12-01T14:00:23ZCleopatraPrepare manual for translationCleopatraCleopatrahttps://code.briarproject.org/briar/briar-manual/-/issues/4Improve manual2021-01-31T04:27:47ZCleopatraImprove manualWe need more content and rich media. The document structure can be improved too.
#### Proposed structure
```
- Migrate to https://docs.briarproject.org/ ??
- Content:
About Briar:
What is Briar
How Briar w...We need more content and rich media. The document structure can be improved too.
#### Proposed structure
```
- Migrate to https://docs.briarproject.org/ ??
- Content:
About Briar:
What is Briar
How Briar works
Installation:
Google Play
F-droid
Apk
Running Briar for the first time:
Creating an account
Contacts:
Add Contacts:
Add contact at a distance
Add contact nearby
Deleting contacts
Introducing contacts
Messaging:
Private Groups:
Create a group
Invite contacts
Forums
Blogs:
Write a blog post
Reblog
RSS Feeds
Settings:
Language & Region
Theme
Connections:
Via the internet
Via Wi-Fi
Via Bluetooth
Connection method for Tor network
Use mobile data
Connect to the internet only when charging
Security:
App lock
Change password
Panic button
Notifications
Feedback
Updating:
Google Play
F-droid
Apk
Uninstalling
Known issues/limitations
```CleopatraCleopatrahttps://code.briarproject.org/briar/website/-/issues/28Add "Support" page2022-11-18T17:32:17ZCleopatraAdd "Support" pageLet's consider having a "Support" page
#### Proposed structure
- Links:
User manual
Known issues/limitations
Open issues on Gitlab
- FAQs:
Migrate from https://code.briarproject.org/briar/briar/-...Let's consider having a "Support" page
#### Proposed structure
- Links:
User manual
Known issues/limitations
Open issues on Gitlab
- FAQs:
Migrate from https://code.briarproject.org/briar/briar/-/wikis/FAQ
Expand FAQs
- Get in Touch:
https://chat.briarproject.org/
IRC
Email
- Glossary
- Report a bug
- Request a feature / Give feedbackCleopatraCleopatrahttps://code.briarproject.org/briar/website/-/issues/25Write guides on how to contribute2021-04-12T11:16:53ZCleopatraWrite guides on how to contributeCurrently, the [Get Involved](https://briarproject.org/get-involved/) page is not very detailed. It'll be nice to have detailed guides on how to contribute to Briar, depending on skills and interests.
### Proposed structure
Make a ...Currently, the [Get Involved](https://briarproject.org/get-involved/) page is not very detailed. It'll be nice to have detailed guides on how to contribute to Briar, depending on skills and interests.
### Proposed structure
Make a donation
Share your experience:
- Report bugs
- Test Briar
- Provide feedback
- Help other Briar users
Contribute your language skills:
- Improve documentation
- Write news and blog posts
- Translate
Promote Briar:
- Write press releases
- Design outreach material
- Talk about Briar at events
Contribute your computer skills:
- Work on the source code
- Improve Briar's infrastructure
- Improve the website
- Design graphics
- Improve UX
Reference documents:
- Code of conduct
- Merge policy
- Release process & schedule
- Glossary
- Logo
- Developer docs
Contributor tools:
- Source code: Git repositories
- Roadmap
- Building the app from source
- Starter tasks for new contributors
- Git workflow
- Join the mailing listCleopatraCleopatrahttps://code.briarproject.org/briar/briar-manual/-/issues/3Update manual to explain globe icon colours2020-11-15T16:15:46ZCleopatraUpdate manual to explain globe icon coloursAs mentioned [here](https://code.briarproject.org/briar/briar/-/issues/1763#note_41736):
> Sorry, we haven't updated the manual yet to explain the icon colours. Orange means Briar is connecting to the Tor network - messages can't be sent...As mentioned [here](https://code.briarproject.org/briar/briar/-/issues/1763#note_41736):
> Sorry, we haven't updated the manual yet to explain the icon colours. Orange means Briar is connecting to the Tor network - messages can't be sent or received via the Internet in this state. Green means Briar's connected to the Tor network and it should be possible to send or receive messages (although it may take a minute or two before your contacts notice that you're connected and try to send any messages that were waiting to send).CleopatraCleopatrahttps://code.briarproject.org/briar/briar/-/issues/1748User testing for transport toggles, second round2020-11-15T15:34:28ZakwizgranUser testing for transport toggles, second roundSubtask of #1723.Subtask of #1723.https://code.briarproject.org/briar/briar/-/issues/1690Add private message deletion to user manual2020-11-15T17:10:49ZakwizgranAdd private message deletion to user manualCleopatraCleopatrahttps://code.briarproject.org/briar/briar/-/issues/1578Improve structure of Briar Headless API documentation2021-03-22T10:52:52ZNicoImprove structure of Briar Headless API documentationCurrently, the documentation for the API is directly written into [its readme file](https://code.briarproject.org/briar/briar/blob/release-1.1.7/briar-headless/README.md). That's fine for the beginning, [I was even able to build a first ...Currently, the documentation for the API is directly written into [its readme file](https://code.briarproject.org/briar/briar/blob/release-1.1.7/briar-headless/README.md). That's fine for the beginning, [I was even able to build a first prototype with it](https://nico.dorfbrunnen.eu/posts/2019/briar-first-demo/).
However, I suggest to improve the structure of the documentation by moving it into a separate repository. My suggestion was to create a Hugo page with a docs theme (or some other static site generator) at docs.briarproject.org.
@grote's response to this was (loosely translated by me): "Best to make the documentation directly into the code with swagger"
My response to this now: OK, we can do this, but I don't know how much sense it makes to put a lot of basic explanations into code. E.g. all the valuable information collected in https://code.briarproject.org/briar/briar/issues/1577.
**Update:** I agree with Torsten that it's best to generate the documentation from code. That's what I do with [`briar_wrapper`](https://code.briarproject.org/briar/python-briar-wrapper), too, at https://wrapper.docs.briarproject.org/ and the API's docs can be hosted at https://api.docs.briarproject.org/, imho.CleopatraCleopatrahttps://code.briarproject.org/briar/briar/-/issues/1531Update threat model document2020-11-15T18:57:13ZakwizgranUpdate threat model documentThe [threat model document](https://code.briarproject.org/briar/briar/wikis/threat-model) on the wiki is out of date, and it doesn't mention the goal of concealing the fact that Briar is being used. The document should be updated.The [threat model document](https://code.briarproject.org/briar/briar/wikis/threat-model) on the wiki is out of date, and it doesn't mention the goal of concealing the fact that Briar is being used. The document should be updated.CleopatraCleopatrahttps://code.briarproject.org/briar/briar/-/issues/1472Explain how Briar is different (rename the "blog"?)2022-11-18T17:24:07ZBjarni RĂșnar EinarssonExplain how Briar is different (rename the "blog"?)Hi! Thanks for Briar, I'm very impressed with what you've done so far.
I was testing it for a bit (the wife and I now have the world's most secure shopping-list app!), and I wanted to share my first impression before it fades. Please fe...Hi! Thanks for Briar, I'm very impressed with what you've done so far.
I was testing it for a bit (the wife and I now have the world's most secure shopping-list app!), and I wanted to share my first impression before it fades. Please feel free to close this issue if you feel it's unhelpful or redundant.
Basically, my dominant feeling was confusion.
What is all this stuff? How does it work? The messages and contacts are straightforward, and the private groups as well... but the forums and blogs had me scratching my head. I still don't fully get them.
How do people discover a blog, or a forum? Are they completely public? Are they shared word-of-mouth over messages? Are there any access controls?
The fact that I couldn't edit or delete blog posts after writing a couple of inane tests was very unsettling - this goes against the expectations any normal user will have for something named "blog", and it's bad enough that after perfectly normal "test behaviour" one is likely going to be forced to delete one's account and start over because anyone with a quirky (let alone risque) sense of humour is likely to write "test posts" that absolutely shouldn't stay on the public record.
I'm technical enough to understand that a lot of this has to do with the underlying p2p distribution, and is also likely emergent from the design goal of making things censorship resistant. But for someone less technical, these limitations are simply baffling and disconcerting. They're also a major roadblock to adoption - I will never use a blog like this as a casual, social tool for expressing myself, and I would strongly recommend against their use to anyone else as well. For personal safety, being able to edit and delete and curate ones' public identity is vital.
There is absolutely a place and a need in this world for a feature like this - but my personal feeling is it needs to be carefully explained and shouldn't be called "blog", as that word implies all sorts of casual social interactions which this is simply inappropriate for (in its current iteration).
But obviously these are just my opinions, I hope they're helpful!CleopatraCleopatrahttps://code.briarproject.org/briar/briar/-/issues/1312Include user manual in app2022-11-18T17:32:16ZakwizgranInclude user manual in appA user asked for the manual to be included in the app. This was always the plan but it doesn't look like we had a ticket for it.
Related to #94, #315.A user asked for the manual to be included in the app. This was always the plan but it doesn't look like we had a ticket for it.
Related to #94, #315.CleopatraCleopatrahttps://code.briarproject.org/briar/website/-/issues/10Update APK download page2021-01-15T02:31:20ZakwizgranUpdate APK download pageThe direct download instructions are out of date for recent versions of Android.The direct download instructions are out of date for recent versions of Android.https://code.briarproject.org/briar/briar/-/issues/1244Update manual for image attachments2021-11-04T11:04:01ZakwizgranUpdate manual for image attachmentsSubtask of #1237.Subtask of #1237.Android 1.4CleopatraCleopatrahttps://code.briarproject.org/briar/briar/-/issues/1238Design changes to sync protocol to support multi-block messages2022-06-15T12:02:16ZakwizgranDesign changes to sync protocol to support multi-block messagesSubtask of #1237.Subtask of #1237.Multi-block messages