diff --git a/README.md b/README.md index cb1b9766d5a480e96a5795d6438f83f26464cb0c..eda2f97a9714c24ef640b01c41a18ab40be1467f 100644 --- a/README.md +++ b/README.md @@ -4,27 +4,25 @@ ### Caracteristicas -El **bfanodo** es un container/docker que podes bajar y correr en tu -propia maquina, maquina virtual o datacenter. Se levanta como un nodo -transaccional, **sin cuentas**, abierto a todo el mundo. -Si no queres brindar este servicio a la red, podes usar *ipfilter* o -(mas facil) no publicar el puerto 8545 (atalo (bind) a 127.0.0.1 -solamente, igual que puerto 8546). Para hacer eso, tenes que cambiar -los parametros `-p` en `start.sh`. - -Como ves en el ejemplo abajo, puerto 30303/tcp y 8545/tcp estan abiertos al -mundo (0.0.0.0 = INADDR_ANY) y 8546/tcp esta abierto solamente para -conecciones de tu maquina. +El **bfanodo** es un container/Docker que se puede descargar y correr en tu +propia servidor, maquina virtual o datacenter. + +Se levanta como un nodo transaccional, **sin cuentas**, abierto a todo el mundo. +Si no deseas brindar este servicio a la red, se puede usar *ipfilter* o, +directamente no publicar los puertos 8545 y 8546 (anclados únicamente a 127.0.0.1). Para hacer eso, hay que cambiar los parametros +`-p` en `start.sh`. + +Como se puede apreciar en el ejemplo aquà abajo, los puertos 30303/tcp, 8545/tcp y 8546/tcp estan abiertos al +mundo (0.0.0.0 = INADDR_ANY). ``` $ docker container port bfanodo 30303/tcp -> 0.0.0.0:30303 8545/tcp -> 0.0.0.0:8545 -8546/tcp -> 127.0.0.1:8546 +8546/tcp -> 0.0.0.0:8546 ``` -Es importante entender que "tu maquina" incluye otros dockers en -la misma maquina, si las has conectado con el parametro `--link`, -como se puede ver aqui: +Es importante entender que si tu servidor incluye otros dockers, se pueden conectar con el parametro `--link`, +como se puede ver aqui: ``` $ docker run --rm -it --link bfanodo alpine env | grep BFANODO_PORT | sort BFANODO_PORT_30303_TCP_ADDR=172.17.0.2 @@ -45,8 +43,8 @@ BFANODO_PORT_8546_TCP_PROTO=tcp BFANODO_PORT_8546_TCP=tcp://172.17.0.2:8546 BFANODO_PORT=tcp://172.17.0.2:8545 ``` -Los puertos estan disponibles de los otros dockers tambien sin usar -`--link` pero no van a estar publicados en variables del entorno. +Los puertos de los otros dockers están disponibles, sin usar +`--link` . Pero no van a estar publicados en las variables del entorno. ``` $ docker run --rm alpine sh -c "date | nc 172.17.0.2 8545" ; echo HTTP/1.1 400 Bad Request @@ -59,24 +57,24 @@ Connection: close ### Cuentas -Una leccion aprendido durante el primer año de BFA es, que el `geth` -normalmente no necesita una cuenta asociado (eso obviamente es distinto si -lo usas como nodo sellador). +Una leccion aprendida durante el primer año de BFA es que el `geth` +normalmente no necesita una cuenta asociada (esto obviamente es distinto si +se utiliza como nodo sellador). -Las cuentas deben estar asociados a los applicaciones que se conecta al -nodo. Ese hace es sistema mas seguro, y **cada applicacion necesita su +Las cuentas deben estar asociadas a las applicaciones que se conectan al +nodo. Esto hace que el sistema sea más seguro, y que **cada applicacion necesite su propia cuenta**. -Si no sos miembro del grupo `docker` (en `/etc/group` ) tenes que hacer todo como `root` +Si no sos miembro del grupo `docker` (en `/etc/group` ) deberás hacer todo como `root` -Te va a crear un directorio en `~/dockers/volumes/bfanodo,home,bfa,bfa,network,node,geth` . Si tenes cuentas/llaves van ahi. Toda la blockchain tambien se ve ahi, para que no hay que bajar toda la blockchain de vuelta al actualizar el nodo. +AsÃ, se creará un directorio en `~/dockers/volumes/bfanodo,home,bfa,bfa,network,node,geth` . Si tenés cuentas/llaves, van allÃ. Toda la blockchain tambien se puede ver en ese mismo lugar, para que no haya que descargarla nuevamente al actualizar el nodo. ### Instalando Docker En [https://docs.docker.com/install/] hay instrucciones para instalar Docker para varios sistemas (CentOS, Debian, Fedora, Ubuntu). -Una vez instalado, podes correr varios dockers a la vez. Si ves el aviso `WARNING: Your kernel does not support swap limit capabilities or the cgroup is not mounted. Memory limited without swap.` la solucion posible esta en https://docs.docker.com/install/linux/linux-postinstall/#your-kernel-does-not-support-cgroup-swap-limit-capabilities +Una vez instalado, podés correr varios dockers a la vez. Si ves el aviso `WARNING: Your kernel does not support swap limit capabilities or the cgroup is not mounted. Memory limited without swap.` la solucion posible está en [https://docs.docker.com/install/linux/linux-postinstall/#your-kernel-does-not-support-cgroup-swap-limit-capabilities] Normalmente es suficiente (en Debian) con: ``` @@ -94,7 +92,7 @@ $ ./start.sh ### Registros / logs -Para ver como esta tu bfanodo, estos comandos pueden brindar mas informacion (y hasta darte un shell): +Estos comandos pueden brindar mas informacion sobre tu bfanodo (y hasta darte un shell): ``` $ docker stats bfanodo $ docker logs bfanodo @@ -105,4 +103,4 @@ $ docker exec -it bfanodo bash ### Crear -Para crear el docker uso el script `build.sh`. No lo uses si no sabes como funciona todo. \ No newline at end of file +Para crear el docker se utilizó el script `build.sh`. Por favor, no lo uses si no sabés como funciona todo. \ No newline at end of file