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.

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

Readme Updated, Docker Compose Improved #60

Open
wants to merge 47 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 46 commits
Commits
Show all changes
47 commits
Select commit Hold shift + click to select a range
874c63e
Update README.md
GitXpresso Nov 8, 2024
b3e3328
Update README.md
GitXpresso Nov 8, 2024
5310df7
Update docker-compose.yml
GitXpresso Nov 8, 2024
8f16f9d
Update README.md
GitXpresso Nov 8, 2024
4f97829
Update README.md
GitXpresso Nov 8, 2024
0be3e0f
Update README.md
GitXpresso Nov 8, 2024
2d43672
Update README.md
GitXpresso Nov 8, 2024
da4ffc9
Update README.md
GitXpresso Nov 9, 2024
54bd132
Update README.md
GitXpresso Nov 9, 2024
a7a79d6
Update README.md
GitXpresso Nov 9, 2024
01785bd
Update README.md
GitXpresso Nov 9, 2024
2fa97f8
Update README.md
GitXpresso Nov 9, 2024
36cb82c
Update README.md
GitXpresso Nov 9, 2024
9db7979
Update README.md
GitXpresso Nov 9, 2024
fb2e493
Update README.md
GitXpresso Nov 9, 2024
b2b00ae
Update README.md
GitXpresso Nov 9, 2024
3fbeaf0
Update README.md
GitXpresso Nov 9, 2024
1daff17
Update README.md
GitXpresso Nov 9, 2024
d515b6a
Update README.md
GitXpresso Nov 9, 2024
05da9a5
Update README.md
GitXpresso Nov 9, 2024
aafdafa
Update README.md
GitXpresso Nov 9, 2024
d7c9f00
Update README.md
GitXpresso Nov 9, 2024
14ea06c
Update README.md
GitXpresso Nov 9, 2024
b1017a5
Update README.md
GitXpresso Nov 9, 2024
7ff150d
Update README.md
GitXpresso Nov 9, 2024
89d9e23
Update README.md
GitXpresso Nov 9, 2024
82c25c4
Update README.md
GitXpresso Nov 9, 2024
24692b7
Update README.md
GitXpresso Nov 9, 2024
979b166
Update README.md
GitXpresso Nov 9, 2024
0ad6653
Update README.md
GitXpresso Nov 9, 2024
207ee6a
Update README.md
GitXpresso Nov 9, 2024
d1f92f2
Update README.md
GitXpresso Nov 9, 2024
a46c8b0
Update README.md
GitXpresso Nov 9, 2024
92b8c38
Update README.md
GitXpresso Nov 9, 2024
f4da757
Update README.md
GitXpresso Nov 9, 2024
0cc6111
Update README.md
GitXpresso Nov 9, 2024
b31525b
Update README.md
GitXpresso Nov 9, 2024
c38eabf
Update README.md
GitXpresso Nov 9, 2024
53d930e
Update Dockerfile
GitXpresso Dec 14, 2024
ebc1451
Create readme.md
GitXpresso Dec 14, 2024
56f91dd
Update Dockerfile
GitXpresso Dec 14, 2024
400abc8
Update DockerfileO
GitXpresso Dec 14, 2024
6393a11
Update Dockerfile
GitXpresso Dec 14, 2024
0ad3b30
Update Dockerfile
GitXpresso Dec 18, 2024
a48eb7a
Update README.md
GitXpresso Dec 26, 2024
c6dcd35
Update docker-compose.yml
GitXpresso Dec 26, 2024
c1a6579
Merge branch 'DomiStyle:master' into master
GitXpresso Dec 26, 2024
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
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ FROM jlesage/baseimage-gui:ubuntu-22.04-v4 AS builder

ARG LOCALE="en-US"

ENV TOR_VERSION_X64="13.0.13"
ENV TOR_VERSION_X64="14.0.3"
ENV TOR_VERSION_ARM64="13.0.9"

# automatic; passed in by Docker buildx
Expand Down
73 changes: 68 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,32 @@
# Tor browser
# Tor
<p align="center">
<img width="300px" src="https://upload.wikimedia.org/wikipedia/commons/8/8f/Tor_project_logo_hq.png">
</p

# Table of Contents

<details><summary>Docker</summary>

- [Docker Container Commands](#Docker-Container-Commands)

- [Docker Installation](#How-to-install-Docker)

</details>

<details><summary>Configuration</summary>

- [Platform configuration](#Platform-configuration)
- [Browser configuration](#Browser-configuration)

</details>

<details><summary>Others</summary>

- [Volumes](#Volumes)
- [Port](#Port)
- [Issues And limitations](#Issues-And-limitations)

</details>

![](https://github.com/DomiStyle/docker-tor-browser/raw/master/screenshot.png)
*Tor browser running inside of Firefox*
Expand All @@ -13,9 +41,9 @@ Both amd64 and arm64 container runtimes are supported, but only the amd64 image

# Usage

See the docker-compose [here](https://github.com/DomiStyle/docker-tor-browser/blob/master/docker-compose.yml) or use this command:
See the docker-compose [here](https://github.com/DomiStyle/docker-tor-browser/blob/master/docker-compose.yml) or use this command

docker run -d -p 5800:5800 domistyle/tor-browser
docker run -d -p 5800:5800 --r estart always --name tor domistyle/tor-browser
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is a typo in this command: --r estart should be --restart (extra space after the r should be removed)


The web interface will be available on port 5800.

Expand Down Expand Up @@ -46,13 +74,48 @@ cp mozilla.cfg.template mozilla.cfg

It is not recommended to add persistent volumes to your Tor Browser. We do not support any issues that arise from persistent volumes.

## Ports
# Docker Container Commands
To install tor browser using docker compose, copy and paste the command in your terminal
```bash
docker compose up
```
To stop the docker container do
```bash
docker stop tor
```
To start the container again, put the following command below and paste it in your terminal
```bash
docker start tor
```
To remove the container you can do
```bash
docker compose down
```
or you can do this
```
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please include the bash syntax highlighting here for consistency

docker rm tor
```
# How to install Docker

### if you don't have curl then just do this
```
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please include the bash syntax highlighting here for consistency

sudo apt install curl -y
```

### install docker using curl
```
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please include the bash syntax highlighting here for consistency

curl -fsSL https://get.docker.com/ | bash
```


## Port

| Port | Description |
|------------|----------------------------------------------|
| `5800` | Provides a web interface to access the Tor browser |
| `5900` | Provides direct access to the VNC server |

## Issues & limitations
## Issues And limitations

* shm_size might need to be set to 2GB or more if you experience crashes
<!-- nonthing was deleted here 🙄 -->
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove this unnecessary comment

3 changes: 2 additions & 1 deletion docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@ version: '3.9'
services:
tor:
image: domistyle/tor-browser
restart: always
container_name: tor
restart: always # Dont change the restart configuration if you want tor security features to function properly
ports:
- 5800:5800
- 5900:5900
Expand Down
50 changes: 50 additions & 0 deletions links/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# /repositories/home:/hawkeye116477:/waterfox/xUbuntu_24.10 - openSUSE Download
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove this file from the PR, it is not relevant to this project


> https://download.opensuse.org/repositories/home:/hawkeye116477:/waterfox/xUbuntu_24.10

/repositories/home:/hawkeye116477:/waterfox/xUbuntu\_24.10 - openSUSE Download
===============

[![Image 3: openSUSE icon](https://static.opensuse.org/favicon.svg) Download](https://download.opensuse.org/)

* [Shortcuts](https://download.opensuse.org/repositories/home:/hawkeye116477:/waterfox/xUbuntu_24.10#)

[debug](https://download.opensuse.org/debug/) [distribution](https://download.opensuse.org/distribution/) [factory](https://download.opensuse.org/factory/) [ports](https://download.opensuse.org/ports/) [repositories](https://download.opensuse.org/repositories/) [source](https://download.opensuse.org/source/) [tumbleweed](https://download.opensuse.org/tumbleweed/) [update](https://download.opensuse.org/update/)


* [![Image 4: openSUSE logo](https://download.opensuse.org/asset/f8027e92e2/logo.svg) MirrorCache](https://download.opensuse.org/repositories/home:/hawkeye116477:/waterfox/xUbuntu_24.10#)

[Mirrors](https://download.opensuse.org/app/server) [Packages](https://download.opensuse.org/app/package) [Projects](https://download.opensuse.org/app/project) [Efficiency](https://download.opensuse.org/app/efficiency) [Statistics](https://download.opensuse.org/rest/stat)

### User menu

[Log in](https://download.opensuse.org/login)

* [Reports](https://download.opensuse.org/repositories/home:/hawkeye116477:/waterfox/xUbuntu_24.10#)
* [All Mirrors](https://download.opensuse.org/report/mirrors)
* [15.4 Mirrors](https://download.opensuse.org/report/mirrors/154)
* [15.5 Mirrors](https://download.opensuse.org/report/mirrors/155)
* [TW Mirrors](https://download.opensuse.org/report/mirrors/tumbleweed)
* [Build Service Mirrors](https://download.opensuse.org/report/mirrors/repositories)
* [Downloads/project](https://download.opensuse.org/report/download?group=project)
* [Downloads/mirror](https://download.opensuse.org/report/download?group=mirror)
* [Downloads/OS](https://download.opensuse.org/report/download?group=os)
* [Downloads/country](https://download.opensuse.org/report/download?group=country)
* [Downloads/arch](https://download.opensuse.org/report/download?group=arch)
* [Downloads/type](https://download.opensuse.org/report/download?group=type)

1. [^](https://download.opensuse.org/)
2. [repositories](https://download.opensuse.org/repositories/)
3. [home:](https://download.opensuse.org/repositories/home:/)
4. [hawkeye116477:](https://download.opensuse.org/repositories/home:/hawkeye116477:/)
5. [waterfox](https://download.opensuse.org/repositories/home:/hawkeye116477:/waterfox/)
6. [xUbuntu\_24.10](https://download.opensuse.org/app/folder/10389792)

| Name | Last Modified | Size |
| --- | --- | --- |

DB was [synched](https://download.opensuse.org/app/folder/10389792) : 2024-12-13T18:36:17

© 2021-2024 SUSE LLC., openSUSE contributors

[Legal notice](https://en.opensuse.org/Imprint) [Source code](https://github.com/openSUSE/MirrorCache) [Report issue](https://github.com/openSUSE/MirrorCache/issues/new) MirrorCache 1.089