mirror of
https://github.com/freedombox/FreedomBox.git
synced 2026-01-21 07:55:00 +00:00
doc: Fetch latest manual
Signed-off-by: James Valleroy <jvalleroy@mailbox.org>
This commit is contained in:
James Valleroy
parent
d99621c946
commit
855fe8fc20
@ -8,6 +8,58 @@ For more technical details, see the [[https://salsa.debian.org/freedombox-team/f
|
||||
|
||||
The following are the release notes for each !FreedomBox version.
|
||||
|
||||
== FreedomBox 23.11 (2023-06-05) ==
|
||||
|
||||
=== Highlights ===
|
||||
|
||||
* *: Fix icons not present in the generated .deb
|
||||
* shadowsocksserver: Add separate app for Shadowsocks server
|
||||
|
||||
=== Other Changes ===
|
||||
|
||||
* apache: Fix failure during app update
|
||||
* apache: Use drop-in config component for /etc files
|
||||
* bepasty: Use drop-in config component for /etc files
|
||||
* calibre: Use drop-in config component for /etc files
|
||||
* cockpit: Use drop-in config component for /etc files
|
||||
* config: Add new component for managing drop-in /etc/ config files
|
||||
* debian/install: Add new place in /usr to keep drop-in config files
|
||||
* deluge: Use drop-in config comonents for /etc files
|
||||
* ejabberd: Use drop-in config component for /etc files
|
||||
* email: Use drop-in config component for /etc files
|
||||
* gitweb: Use drop-in config component for /etc files
|
||||
* i2p: Use drop-in config component for /etc files
|
||||
* ikiwiki: Use drop-in config component for /etc files
|
||||
* janus: Use drop-in config component for /etc files
|
||||
* letsencrypt: Use drop-in config component for /etc files
|
||||
* matrixsynapse: Use drop-in config component for /etc files
|
||||
* mediawiki: Use drop-in config component for /etc files
|
||||
* minidlna: Use drop-in config component for /etc files
|
||||
* networks: Use drop-in config component for /etc files
|
||||
* pagekite: Drop the config file for forcing use of Debian certs
|
||||
* privacy: Use drop-in config component for /etc files
|
||||
* radicale: Use drop-in config component for /etc files
|
||||
* roundcube: Use drop-in config component for /etc files
|
||||
* rssbridge: Use drop-in config component for /etc files
|
||||
* searx: Use drop-in config component for /etc files
|
||||
* security: Use drop-in config component for /etc files
|
||||
* sharing: Use drop-in config component for /etc files
|
||||
* ssh: Use drop-in config component for /etc files
|
||||
* sso: Use drop-in config component for /etc files
|
||||
* syncthing: Use drop-in config component for /etc files
|
||||
* transmission: Use drop-in config component for /etc files
|
||||
* ttrss: Use drop-in config component for /etc files
|
||||
* upgrades: Use drop-in config component for /etc files
|
||||
* users: Use drop-in config component for /etc files
|
||||
* wordpress: Use drop-in config component for /etc files
|
||||
|
||||
== FreedomBox 23.10 (2023-05-22) ==
|
||||
|
||||
* *: Move modules-enabled files to /usr/share
|
||||
* locale: Update translations for Dutch, Portuguese, Spanish, Turkish, Ukrainian
|
||||
* doc/dev: Set language code explicitly in Sphinx configuration
|
||||
* gitweb: Disable gpg signing in tests
|
||||
|
||||
== FreedomBox 23.9 (2023-05-08) ==
|
||||
|
||||
=== Highlights ===
|
||||
|
||||
@ -8,32 +8,51 @@
|
||||
|
||||
## BEGIN_INCLUDE
|
||||
|
||||
== Shadowsocks (SOCKS5 proxy) ==
|
||||
== Shadowsocks (Bypass Censorship) ==
|
||||
||<tablestyle="float: right;"> {{attachment:Shadowsocks-icon_en_V01.png|Shadowsocks icon}} ||
|
||||
|
||||
'''Available since''': version 0.18.0
|
||||
|
||||
=== What is Shadowsocks? ===
|
||||
|
||||
Shadowsocks is a lightweight and secure SOCKS5 proxy, designed to protect your Internet traffic. It can be used to bypass Internet filtering and censorship. Your !FreedomBox can run a Shadowsocks client which can connect to a Shadowsocks server. It will also run a SOCKS5 proxy. Local devices can connect to this proxy, and their data will be encrypted and proxied through the Shadowsocks server.
|
||||
Shadowsocks is a tool for securely forwarding network requests to a remote server. It consists of two parts: (1) a Shadowsocks server, and (2) a Shadowsocks client with a SOCKS5 proxy.
|
||||
|
||||
=== Using the Shadowsocks client? ===
|
||||
Shadowsocks can be used to bypass Internet filtering and censorship. This requires that the Shadowsocks server is in a location where it can freely access the Internet, without filtering.
|
||||
|
||||
The current implementation of Shadowsocks in !FreedomBox only supports configuring !FreedomBox as a Shadowsocks client. The current use case for Shadowsocks is as follows:
|
||||
* Shadowsocks client (!FreedomBox) is in a region where some parts of the Internet are blocked or censored.
|
||||
* Shadowsocks server is in a different region, which doesn't have these blocks.
|
||||
* The !FreedomBox provides SOCKS proxy service on the local network for other devices to make use of its Shadowsocks connection.
|
||||
Your !FreedomBox can run a Shadowsocks client which can connect to a Shadowsocks server. It will also run a SOCKS5 proxy. Local devices can connect to this proxy, and their data will be encrypted and proxied through the Shadowsocks server.
|
||||
|
||||
At a future date it will be possible to configure !FreedomBox as Shadowsocks server.
|
||||
Alternatively, your !FreedomBox can run a Shadowsocks server, that allows Shadowsocks clients to connect to it. Clients' data will be encrypted and proxied through this server.
|
||||
|
||||
=== Configuring your FreedomBox for the Shadowsocks client ===
|
||||
=== Using Shadowsocks? ===
|
||||
|
||||
To enable Shadowsocks, first navigate to the Socks5 Proxy (Shadowsocks) page and install it.
|
||||
Shadowsocks can be used as follows:
|
||||
* Shadowsocks Client (a !FreedomBox) is in a region where some parts of the Internet are blocked or censored.
|
||||
* Shadowsocks Server (a different !FreedomBox, or another server) is in a different region, which doesn't have these blocks.
|
||||
* The !FreedomBox running Shadowsocks Client provides SOCKS proxy service on the local network for other devices to make use of its Shadowsocks connection to the server.
|
||||
|
||||
Server: the Shadowsocks server is not the !FreedomBox IP or URL; rather, it will be another server or VPS that has been configured as a Shadowsocks server. There are also some public Shadowsocks servers listed on the web, but be aware that whoever operates the server can see where requests are going, and any non-encrypted data will be visible to them.
|
||||
{{attachment:Shadowsocks-diagram_en_V01.png|Shadowsocks connection diagram|width=500}}
|
||||
|
||||
To use Shadowsocks after setup, set the SOCKS5 proxy URL in your device, browser or application to http://freedombox_address:1080/
|
||||
=== Configuring your FreedomBox for Shadowsocks Client ===
|
||||
|
||||
To enable Shadowsocks Client, first navigate to the Shadowsocks Client (Bypass Censorship) page, and install it.
|
||||
|
||||
Server: the Shadowsocks server is not this !FreedomBox's IP or URL; rather, it will be another server or VPS that has been configured as a Shadowsocks server. There are also some public Shadowsocks servers listed on the web, but be aware that whoever operates the server can see where requests are going, and any non-encrypted data will be visible to them.
|
||||
|
||||
To use Shadowsocks Client after setup, set the SOCKS5 proxy URL in your device, browser or application to http://freedombox_address:1080/
|
||||
|
||||
=== Configuring your FreedomBox for Shadowsocks Server ===
|
||||
|
||||
To enable Shadowsocks Server, first navigate to the Shadowsocks Server (Help Others Bypass Censorship) page, and install it.
|
||||
|
||||
'''Note''': In general, a !FreedomBox should be set up as either a Shadowsocks Server, or a Shadowsocks Client, but not both!
|
||||
|
||||
For Shadowsocks Clients to connect to your server, they will need to know your domain name, the password, and the encryption method.
|
||||
|
||||
==== Port Forwarding ====
|
||||
|
||||
If your !FreedomBox is behind a router, you will need to set up port forwarding on your router. You should forward the following ports for Shadowsocks Server:
|
||||
* TCP 8388
|
||||
* UDP 8388
|
||||
|
||||
=== External links ===
|
||||
|
||||
|
||||
@ -77,6 +77,17 @@ Auto-update is recommended for most users. However if you want to do the update
|
||||
|
||||
* Take backups of your apps' data before performing the update.
|
||||
* Create a system snapshot before you begin.
|
||||
* General [[DebianUpgrade|instructions]] for upgrading Debian distribution are available.
|
||||
* Some packages are known to have prompts during upgrade, due to modified conffiles. It is recommended not to upgrade these packages manually, but rather to allow !FreedomBox to handle their upgrade automatically. This applies to the following packages:
|
||||
* bind9
|
||||
* firewalld
|
||||
* janus
|
||||
* minetest-server
|
||||
* minidlna
|
||||
* mumble-server
|
||||
* radicale
|
||||
* roundcube-core
|
||||
* tt-rss
|
||||
|
||||
## END_INCLUDE
|
||||
|
||||
|
||||
BIN
doc/manual/en/images/Shadowsocks-diagram_en_V01.png
Normal file
BIN
doc/manual/en/images/Shadowsocks-diagram_en_V01.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 104 KiB |
@ -26,7 +26,7 @@ Tras instalar !GitWeb se puede acceder a !GitWeb mediante el cliente web (p.ej)
|
||||
|
||||
=== Autenticación básica HTTP ===
|
||||
|
||||
Actualmente el !GitWeb de !FreedomBox solo soporta remotos HTTP. Para evitar tener que introducir la contraseña cada vez que haces pull/push al repositorio puedes editar tu remoto para incluír credenciales.
|
||||
Actualmente el !GitWeb de !FreedomBox solo soporta remotos HTTP(S) (no SSH). Para evitar tener que introducir la contraseña cada vez que haces pull/push al repositorio puedes editar tu remoto para incluír credenciales.
|
||||
|
||||
''Ejemplo:'' https://usuario:contrasena@mi.freedombox.mola/gitweb/mirepo
|
||||
|
||||
|
||||
@ -8,6 +8,58 @@ For more technical details, see the [[https://salsa.debian.org/freedombox-team/f
|
||||
|
||||
The following are the release notes for each !FreedomBox version.
|
||||
|
||||
== FreedomBox 23.11 (2023-06-05) ==
|
||||
|
||||
=== Highlights ===
|
||||
|
||||
* *: Fix icons not present in the generated .deb
|
||||
* shadowsocksserver: Add separate app for Shadowsocks server
|
||||
|
||||
=== Other Changes ===
|
||||
|
||||
* apache: Fix failure during app update
|
||||
* apache: Use drop-in config component for /etc files
|
||||
* bepasty: Use drop-in config component for /etc files
|
||||
* calibre: Use drop-in config component for /etc files
|
||||
* cockpit: Use drop-in config component for /etc files
|
||||
* config: Add new component for managing drop-in /etc/ config files
|
||||
* debian/install: Add new place in /usr to keep drop-in config files
|
||||
* deluge: Use drop-in config comonents for /etc files
|
||||
* ejabberd: Use drop-in config component for /etc files
|
||||
* email: Use drop-in config component for /etc files
|
||||
* gitweb: Use drop-in config component for /etc files
|
||||
* i2p: Use drop-in config component for /etc files
|
||||
* ikiwiki: Use drop-in config component for /etc files
|
||||
* janus: Use drop-in config component for /etc files
|
||||
* letsencrypt: Use drop-in config component for /etc files
|
||||
* matrixsynapse: Use drop-in config component for /etc files
|
||||
* mediawiki: Use drop-in config component for /etc files
|
||||
* minidlna: Use drop-in config component for /etc files
|
||||
* networks: Use drop-in config component for /etc files
|
||||
* pagekite: Drop the config file for forcing use of Debian certs
|
||||
* privacy: Use drop-in config component for /etc files
|
||||
* radicale: Use drop-in config component for /etc files
|
||||
* roundcube: Use drop-in config component for /etc files
|
||||
* rssbridge: Use drop-in config component for /etc files
|
||||
* searx: Use drop-in config component for /etc files
|
||||
* security: Use drop-in config component for /etc files
|
||||
* sharing: Use drop-in config component for /etc files
|
||||
* ssh: Use drop-in config component for /etc files
|
||||
* sso: Use drop-in config component for /etc files
|
||||
* syncthing: Use drop-in config component for /etc files
|
||||
* transmission: Use drop-in config component for /etc files
|
||||
* ttrss: Use drop-in config component for /etc files
|
||||
* upgrades: Use drop-in config component for /etc files
|
||||
* users: Use drop-in config component for /etc files
|
||||
* wordpress: Use drop-in config component for /etc files
|
||||
|
||||
== FreedomBox 23.10 (2023-05-22) ==
|
||||
|
||||
* *: Move modules-enabled files to /usr/share
|
||||
* locale: Update translations for Dutch, Portuguese, Spanish, Turkish, Ukrainian
|
||||
* doc/dev: Set language code explicitly in Sphinx configuration
|
||||
* gitweb: Disable gpg signing in tests
|
||||
|
||||
== FreedomBox 23.9 (2023-05-08) ==
|
||||
|
||||
=== Highlights ===
|
||||
|
||||
@ -6,33 +6,52 @@
|
||||
|
||||
## BEGIN_INCLUDE
|
||||
|
||||
== Shadowsocks (Proxy SOCKS5) ==
|
||||
== Shadowsocks (Eludir censura) ==
|
||||
||<tablestyle="float: right;"> {{attachment:FreedomBox/Manual/Shadowsocks/Shadowsocks-icon_en_V01.png|icono de Shadowsocks}} ||
|
||||
|
||||
'''Disponible desde''': versión 0.18.0
|
||||
|
||||
=== ¿Qué es Shadowsocks? ===
|
||||
[[https://shadowsocks.org/en/index.html|Shadowsocks]] es un proxy SOCKS5 ligero y seguro, diseñado para proteger tu tráfico Internet. Se puede usar para eludir la censura y los filtros de Internet. Tu !FreedomBox puede ejecutar un cliente Shadowsocks que puede conectar con un servidor Shadowsocks. También ejecutará un proxy SOCKS5. Los dispositivos locales pueden conectar con este proxy y sus datos serán cifrados y retransmitidos a través del sevidor Shadowsocks.
|
||||
[[https://shadowsocks.org/en/index.html|Shadowsocks]] es una herramienta para reenviar peticiones de red a un servidor remoto de forma segura. Consiste de dos partes: (1) un servidor Shadowsocks y (2) un cliente Shadowsocks con un proxy SOCKS5.
|
||||
|
||||
'''Nota:''' Shadowsocks está disponible en !FreedomBox a partir de la versión 0.18.
|
||||
|
||||
=== Usar el cliente Shadowsocks ===
|
||||
Se puede emplear Shadowsocks para eludir el filtrado de Internet y con ello la censura. Esto requiere un servidor Shadowsocks situado donde pueda acceder con libertad a Internet, sin filtros.
|
||||
|
||||
La implementación actual de Shadowsocks en !FreedomBox solo soporta configurar !FreedomBox como cliente Shadowsocks. Este caso de uso sería así:
|
||||
* El client de Shadowsocks (!FreedomBox) está en una región en la que partes de Internet están bloqueadas o censuradas.
|
||||
Tu !FreedomBox puede ejecutar un cliente Shadowsocks que puede conectar con el servidor Shadowsocks. Ejecutará también un proxy SOCKS5. Los dispositivos locales pueden conectar con este proxy, y sus datos se cifrarán y enrutarán a través del servidor Shadowsocks.
|
||||
|
||||
O bien tu !FreedomBox puede ejecutar un servidor Shadowsocks para que los clientes Shadowsocks conecten con él. Los datos de estos clientes se cifrarán y enrutarán a través de este servidor.
|
||||
|
||||
=== Usar Shadowsocks ===
|
||||
|
||||
El uso de Shadowsocks sería así:
|
||||
* El cliente de Shadowsocks (!FreedomBox) está en una región en la que partes de Internet están bloqueadas o censuradas.
|
||||
* El servidor de Shadowsocks está en una región diferente que no tiene esos bloqueos.
|
||||
* !FreedomBox proporciona un servicio de proxy SOCKS en la red local para que otros dispositivos hagan uso de la conexión Shadowsocks.
|
||||
|
||||
En el futuro será posible configurar !FreedomBox como servidor Shadowsocks.
|
||||
{{attachment:FreedomBox/Manual/Shadowsocks/Shadowsocks-diagram_en_V01.png|Diagrama de conexión de Shadowsocks|width=500}}
|
||||
|
||||
=== Configurar tu FreedomBox para el cliente Shadowsocks ===
|
||||
|
||||
Para habilitar Shadowsocks primero navega a la página Proxy Socks5 (Shadowsocks) e instalalo.
|
||||
Para habilitar el cliente Shadowsocks primero navega a la página del cliente Shadowsocks (Eludir censura) e instalalo.
|
||||
|
||||
Servidor: el servidor Shadowsocks no es la IP o la URL de !FreedomBox, sino que será otro servidor o VPS configurado como tal (servidor Shadowsocks). También hay algunos servidores Shadowsocks públicos listados en la web, pero sé consciente de que quienquiera que opere el servidor puede ver a dónde van las peticiones y cualquier dato no cifrado que se transmita.
|
||||
|
||||
Para usar Shadowsocks una vez instalado configura la URL del proxy SOCKS5 en tu dispositivo, navegador o aplicación como `http://<tu_freedombox>:1080/`.
|
||||
|
||||
=== Configurar tu FreedomBox para el servidor Shadowsocks ===
|
||||
|
||||
Para habilitar el servidor Shadowsocks ve a su página (Ayudar a otros a eludir la censura) e instalalo.
|
||||
|
||||
'''Nota''': En general, una !FreedomBox se configuraría bien como servidor Shadowsocks o bien como cliente, ¡pero no como ambos!
|
||||
|
||||
Para que otros clientes Shadowsocks se conecten a tu servidor necesitarán conocer tu nombre de dominio, la contraseña y el método de cifrado.
|
||||
|
||||
==== Redirección de puertos ====
|
||||
|
||||
Si tu FreedomBox está detrás de un router, necesitarás configurar la redirección de los siguientes puertos para el servidor Shadowsocks:
|
||||
* TCP 8388
|
||||
* UDP 8388
|
||||
|
||||
=== Enlaces externos ===
|
||||
|
||||
|
||||
@ -67,6 +67,17 @@ Para la mayoría de los usuarios se recomienda la autoactualización. Si no obst
|
||||
|
||||
General:
|
||||
* Toma una instantánea del sistema antes de empezar.
|
||||
* Hay disponibles [[DebianUpgrade|instrucciones]] generales para actualizar la distributción Debian.
|
||||
* Se sabe que algunos paquetes preguntan al usuario durante la actualización debido a cambios en los ficheros conf. Se recomienda no actualizar estos paquetes manualmente, sino permitir que !FreedomBox trate sus actualizaciones automaticamente. Nos referimos a los siguientes paquetes:
|
||||
* bind9
|
||||
* firewalld
|
||||
* janus
|
||||
* minetest-server
|
||||
* minidlna
|
||||
* mumble-server
|
||||
* radicale
|
||||
* roundcube-core
|
||||
* tt-rss
|
||||
|
||||
## END_INCLUDE
|
||||
|
||||
|
||||
BIN
doc/manual/es/images/Shadowsocks-diagram_en_V01.png
Normal file
BIN
doc/manual/es/images/Shadowsocks-diagram_en_V01.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 104 KiB |
Loading…
x
Reference in New Issue
Block a user