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

Incremental changes #25

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
TamperDAV
=============
###### README versions: [EN](README.md) | [pt-BR](doc/lang/pt-BR/README_pt-BR.md)

A WebDAV-like server to sync Tampermonkey scripts and edit them with an external editor.
---

**WARNING:** this is not a 100% WebDAV-compliant server. Many clients should, but don't necessarily have to work!
A WebDAV-like server to sync Tampermonkey scripts and edit them with an external editor.

> **WARNING:** this is not a 100% WebDAV-compliant server. Many clients should, but don't necessarily have to work!

# Usage

Expand Down Expand Up @@ -97,3 +99,8 @@ $ TD_USERNAME=derjanb TD_PASSWORD=secret node server.js --path=dav/ --port=6000
- ```no-dialog``` Disables the use of a dialog to show messages to the user
- ```headless``` Implies --no-dialog and disables editor opening
- ```debug``` print debug information

---

# License
[MIT](LICENSE)
24 changes: 24 additions & 0 deletions doc/lang/pt-BR/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
MIT License

Copyright (c) 2018

É concedida permissão, gratuitamente, a qualquer pessoa que obtenha uma cópia
deste software e arquivos de documentação associados (o "Software"), para lidar
no Software sem restrições, incluindo, sem limitação, os direitos
usar, copiar, modificar, mesclar, publicar, distribuir, sublicenciar e/ou vender
cópias do Software e permitir que as pessoas a quem o Software é
capacitado para fazê-lo, sujeito às seguintes condições:

O aviso de direitos autorais acima e este aviso de permissão serão incluídos em todos
cópias ou partes substanciais do Software.

O SOFTWARE É FORNECIDO "COMO ESTÁ", SEM GARANTIA DE QUALQUER TIPO, EXPRESSA OU
IMPLÍCITAS, INCLUINDO, MAS NÃO SE LIMITANDO ÀS GARANTIAS DE COMERCIALIZAÇÃO,
ADEQUAÇÃO A UM DETERMINADO FIM E NÃO VIOLAÇÃO. EM HIPÓTESE ALGUMA O
OS AUTORES OU DETENTORES DE DIREITOS AUTORAIS SERÃO RESPONSÁVEIS POR QUALQUER RECLAMAÇÃO, DANOS OU OUTROS
RESPONSABILIDADE, SEJA EM UMA AÇÃO DE CONTRATO, ATO ILÍCITO OU DE OUTRA FORMA, DECORRENTE DE,
FORA DE OU EM CONEXÃO COM O SOFTWARE OU O USO OU OUTRAS NEGOCIAÇÕES NO
PROGRAMAS.

_____________________________________________________________________________________
Traduzido do Ingês para o português Brasileiro por: Nelis Júnior
89 changes: 89 additions & 0 deletions doc/lang/pt-BR/README_pt-BR.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
TamperDAV
=============

Um servidor semelhante ao WebDAV para sincronizar scripts do Tampermonkey e editá-los com um editor externo.

> **AVISO:** este não é um servidor 100% compatível com WebDAV. Muitos clientes devem, mas não necessariamente precisam funcionar!

# Uso

Certifique-se de que o [Node.js](https://nodejs.org/) maior que v4.9 esteja instalado.

## Windows

Dentro do diretório do projeto, execute ```TamperDAV.bat```

## Linux
Dentro do diretório do projeto, execute
``` sh
$ ./tamperdav.sh
```
## Clientes
[Tampermonkey (4.7.5823+)](https://www.tampermonkey.net/)
<img src="https://user-images.githubusercontent.com/767504/42598819-a1fb04a0-855d-11e8-8b42-a86abf577d82.png" alt="Configurações localhost Tampermonkey"></img>

**Notas:**
> para permitir que o Tampermonkey use o conjunto completo de recursos do TamperDAV, certifique-se de que o TamperDAV esteja executando quando o Tampermonkey for iniciado.

> O Tampermonkey sincronizará todos os scripts em um subdiretório do diretório dav configurado. por exemplo, `Tampermonkey/sync`, usando o UUID gerado internamente para o nome do arquivo. O arquivo real a ser editado pode ser facilmente encontrado executando `node find_script_in_meta.js --name="Nome do Meu Script"`. Alternativamente, você pode encontrar o UUID através da interface do usuário do Tampermonkey, navegando até o script e recuperando-o da barra de endereços conforme mostrado na imagem a seguir.

<img src="https://i.imgur.com/yvXBABL.png" alt="Obtendo o UUID do Script">

### Montagem
Comando Linux para montar o servidor WebDAV
``` sh
sudo mount -t davfs http://localhost:7000 /mnt
```

### Nautilus
Nautilus é o gerenciador de arquivos padrão do GNOME. Para acessar o servidor WebDAV, basta digitar o endereço `dav://localhost:7000/` na barra de endereços do Nautilus.

# Desenvolvimento

``` sh
# Instalar dependências
$ npm install

# Executar
$ mkdir dav
$ node server.js --path=dav/
```

# Configuração

Todas as opções podem ser definidas via config.json e/ou linha de comando. `username` e `password` também podem ser definidos via variáveis de ambiente.


### Exemplo de Linha de Comando
``` sh
$ node server.js --path=dav/ --port=7000 --username=admin --password=1234
```

### Exemplo de configurações do config.json
``` json
{
"port": 7000,
"path": "dav/",
"username": "admin",
"password": "1234"
}
```
### Todas as Opções de Configuração
- `path` um caminho relativo de onde os arquivos devem ser servidos
- `no-auth-warning` não mostrar um aviso se nenhum nome de usuário e senha forem definidos
- `username` nome de usuário para autenticação (auth básica)
- `password` senha
- `port` porta TCP para escutar
- `host` endereço de rede para vincular
- `max-cursors` número de alterações armazenadas em cache
- `open-in-editor` se "true", então se Windows o editor "notepad" é usado, senão `xgd-open`; ou o executável como string, por exemplo, "gedit", "notepad", ...
- `meta-touch` tocar automaticamente no arquivo meta de uma entrada de sincronização para fazer o Tampermonkey iniciar uma sincronização nas alterações do script
- `no-dialog` Desabilita o uso de um diálogo para mostrar mensagens ao usuário
- `headless` Implica --no-dialog e desabilita a abertura do editor
- `debug` imprimir informações de depuração

---

# Licença

[MIT](./LICENSE)