Browse Source

rename default branch from master to main

Nicola Murino 4 years ago
parent
commit
1bccb93fcb

+ 1 - 1
.github/workflows/development.yml

@@ -2,7 +2,7 @@ name: CI
 
 on:
   push:
-    branches: [master]
+    branches: [main]
   pull_request:
 
 jobs:

+ 1 - 1
.github/workflows/docker.yml

@@ -5,7 +5,7 @@ on:
   #  - cron: '0 4 * * *' # everyday at 4:00 AM UTC
   push:
     branches:
-      - master
+      - main
     tags:
       - v*
   pull_request:

+ 5 - 5
README.md

@@ -1,7 +1,7 @@
 # SFTPGo
 
-![CI Status](https://github.com/drakkan/sftpgo/workflows/CI/badge.svg?branch=master&event=push)
-[![Code Coverage](https://codecov.io/gh/drakkan/sftpgo/branch/master/graph/badge.svg)](https://codecov.io/gh/drakkan/sftpgo/branch/master)
+![CI Status](https://github.com/drakkan/sftpgo/workflows/CI/badge.svg?branch=main&event=push)
+[![Code Coverage](https://codecov.io/gh/drakkan/sftpgo/branch/main/graph/badge.svg)](https://codecov.io/gh/drakkan/sftpgo/branch/main)
 [![Go Report Card](https://goreportcard.com/badge/github.com/drakkan/sftpgo)](https://goreportcard.com/report/github.com/drakkan/sftpgo)
 [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
 [![Docker Pulls](https://img.shields.io/docker/pulls/drakkan/sftpgo)](https://hub.docker.com/r/drakkan/sftpgo)
@@ -74,7 +74,7 @@ Some Linux distro packages are available:
 - For Arch Linux via AUR:
   - [sftpgo](https://aur.archlinux.org/packages/sftpgo/). This package follows stable releases. It requires `git`, `gcc` and `go` to build.
   - [sftpgo-bin](https://aur.archlinux.org/packages/sftpgo-bin/). This package follows stable releases downloading the prebuilt linux binary from GitHub. It does not require `git`, `gcc` and `go` to build.
-  - [sftpgo-git](https://aur.archlinux.org/packages/sftpgo-git/). This package builds and installs the latest git master. It requires `git`, `gcc` and `go` to build.
+  - [sftpgo-git](https://aur.archlinux.org/packages/sftpgo-git/). This package builds and installs the latest git `main` branch. It requires `git`, `gcc` and `go` to build.
 - Deb and RPM packages are built after each commit and for each release.
 - For Ubuntu a PPA is available [here](https://launchpad.net/~sftpgo/+archive/ubuntu/sftpgo).
 
@@ -124,10 +124,10 @@ If for some reason you want to downgrade SFTPGo, you may need to downgrade your
 
 We support the follwing schema versions:
 
-- `6`, this is the latest version
+- `8`, this is the latest version
 - `4`, this is the schema for v1.0.0-v1.2.x
 
-So, if you plan to downgrade from git master to 1.2.x, you can prepare your data provider executing the following command from the configuration directory:
+So, if you plan to downgrade from 2.0.x to 1.2.x, you can prepare your data provider executing the following command from the configuration directory:
 
 ```shell
 sftpgo revertprovider --to-version 4

+ 2 - 2
docker/README.md

@@ -8,8 +8,8 @@ SFTPGo provides an official Docker image, it is available on both [Docker Hub](h
 - [v2.0.1-alpine, v2.0-alpine, v2-alpine, alpine](https://github.com/drakkan/sftpgo/blob/v2.0.1/Dockerfile.full.alpine)
 - [v2.0.1-slim, v2.0-slim, v2-slim, slim](https://github.com/drakkan/sftpgo/blob/v2.0.1/Dockerfile)
 - [v2.0.1-alpine-slim, v2.0-alpine-slim, v2-alpine-slim, alpine-slim](https://github.com/drakkan/sftpgo/blob/v2.0.1/Dockerfile.alpine)
-- [edge](../Dockerfile.full)
-- [edge-alpine](../Dockerfile.full.alpine)
+- [edge](../Dockerfile)
+- [edge-alpine](../Dockerfile.alpine)
 - [edge-slim](../Dockerfile)
 - [edge-alpine-slim](../Dockerfile.alpine)
 

+ 1 - 1
docs/performance.md

@@ -2,7 +2,7 @@
 
 SFTPGo can easily saturate a Gigabit connection on low end hardware with no special configuration, this is generally enough for most use cases.
 
-For Multi-Gig connections, some performance improvements and comparisons with OpenSSH have been discussed [here](https://github.com/drakkan/sftpgo/issues/69), most of them have been included in the master branch. To summarize:
+For Multi-Gig connections, some performance improvements and comparisons with OpenSSH have been discussed [here](https://github.com/drakkan/sftpgo/issues/69), most of them have been included in the main branch. To summarize:
 
 - In current state with all performance improvements applied, SFTP performance is very close to OpenSSH however CPU usage is higher. SCP performance match OpenSSH.
 - The main bottlenecks are the encryption and the messages authentication, so if you can use a fast cipher with implicit messages authentication, such as `aes128-gcm@openssh.com`, you will get a big performance boost.

+ 1 - 1
docs/profiling.md

@@ -3,7 +3,7 @@
 The built-in profiler lets you collect CPU profiles, traces, allocations and heap profiles that allow to identify and correct specific bottlenecks.
 You can enable the built-in profiler using `telemetry` configuration section inside the configuration file.
 
-Profiling data are exposed via HTTP/HTTPS in the format expected by the [pprof](https://github.com/google/pprof/blob/master/doc/README.md) visualization tool. You can find the index page at the URL `/debug/pprof/`.
+Profiling data are exposed via HTTP/HTTPS in the format expected by the [pprof](https://github.com/google/pprof/blob/main/doc/README.md) visualization tool. You can find the index page at the URL `/debug/pprof/`.
 
 The following profiles are available, you can obtain them via HTTP GET requests:
 

+ 1 - 1
httpd/httpd.go

@@ -1,6 +1,6 @@
 // Package httpd implements REST API and Web interface for SFTPGo.
 // The OpenAPI 3 schema for the exposed API can be found inside the source tree:
-// https://github.com/drakkan/sftpgo/blob/master/httpd/schema/openapi.yaml
+// https://github.com/drakkan/sftpgo/blob/main/httpd/schema/openapi.yaml
 // A basic Web interface to manage users and connections is provided too
 package httpd
 

+ 1 - 1
main.go

@@ -2,7 +2,7 @@
 // FTP/S and WebDAV support.
 // For more details about features, installation, configuration and usage
 // please refer to the README inside the source tree:
-// https://github.com/drakkan/sftpgo/blob/master/README.md
+// https://github.com/drakkan/sftpgo/blob/main/README.md
 package main // import "github.com/drakkan/sftpgo"
 
 import (

+ 1 - 1
windows-installer/sftpgo.iss

@@ -9,7 +9,7 @@
 #if GetEnv("SFTPGO_ISS_DOC_URL") != ""
     #define DocURL GetEnv("SFTPGO_ISS_DOC_URL")
 #else
-    #define DocURL "https://github.com/drakkan/sftpgo/blob/master/README.md"
+    #define DocURL "https://github.com/drakkan/sftpgo/blob/main/README.md"
 #endif
 #define MyAppExeName "sftpgo.exe"
 #define MyAppDir "..\output"