Git—github搭建与配置.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Git 之github搭建与配置\n",
    "git是分布式的代码管理工具，远程的代码管理是基于ssh的，所以要使用远程的git则需要ssh的配置。以下是详细安装配置过程：<br>\n",
    "### 1、下载安装对应 Github bash：\n",
    "#### 1.1 、设置git的user name和email：<br>\n",
    ">git config --global user.name \"test\"<br>\n",
    "git config --global user.email \"test@gmail.com\"<br>\n",
    "\n",
    "#### 1.2、GitBash 中文乱码解决方案\n",
    "　　1、打开GitBash执行下面命令  \n",
    "```shell\n",
    "git config --global core.quotepath false\n",
    "git config --global gui.encoding utf-8\n",
    "git config --global i18n.commitencoding utf-8\n",
    "git config --global i18n.logoutputencoding utf-8\n",
    "export LESSCHARSET=utf-8\n",
    "```\n",
    "\n",
    "　　2、在{git_home}/etc/bash.bashrc文件最后加入下面两行  \n",
    "```shell\n",
    ">export LANG=\"zh_CN.UTF-8\"  \n",
    "export LC_ALL=\"zh_CN.UTF-8\"  \n",
    "```\n",
    "　　注：{git_home}为Git在windows上的安装目录  \n",
    "\n",
    "　　3、或者打开gitbash终端的选项设置，修改 Text 标签的 Locale 为 zh_CN、Character set 为 UTF-8 ，修改 Window 标签的 UI language 为 zh_CN.\n",
    "\n",
    "### 2、Github 上添加 SSH key：\n",
    "#### 　1、运行 git Bash 客户端，查看是否已创建密钥，输入如下代码：\n",
    "> cd ~/.ssh<br>\n",
    " ls<br>\n",
    "　　\n",
    "  这两个命令就是检查是否已经存在 id_rsa.pub 或 id_dsa.pub 文件（或是自定义的秘钥保存文件），如果文件已经存在，那么你可以跳过步骤2，直接进入步骤3。<br>\n",
    "\n",
    "#### 　2、创建一个 SSH key(密钥）\n",
    ">ssh-keygen -t rsa -C \"your_email@example.com\"<br>\n",
    "ssh-keygen -t rsa -C \"YOUR_EMAIL@YOUREMAIL.COM\" -f ~/.ssh/aysee　　　#　执行完成后，会在 ~/.ssh/目录下生成一个 aysee 和 aysee.pub 文件。\n",
    "\n",
    "代码参数含义：<br>\n",
    ">-t 指定密钥类型，默认是 rsa ，可以省略。<br>\n",
    "-C 设置注释文字，比如邮箱。<br>\n",
    "-f 指定密钥文件存储文件名。<br>\n",
    "\n",
    "以上代码省略了 -f 参数，因此，运行上面那条命令后会让你输入一个文件名，用于保存刚才生成的 SSH key 代码，如：<br>\n",
    ">Generating public/private rsa key pair.<br>\n",
    "\\# Enter file in which to save the key (/c/Users/you/.ssh/id_rsa): [Press enter]<br>\n",
    "\n",
    "当然，你也可以不输入文件名，使用默认文件名（推荐），那么就会生成 id_rsa 和 id_rsa.pub 两个秘钥文件。<br>\n",
    "　　接着又会提示你输入两次密码（该密码是你push文件的时候要输入的密码，而不是github管理者的密码），当然，你也可以不输入密码，直接按回车。那么push的时候就不需要输入密码，直接提交到github上了，如：<br>\n",
    ">Enter passphrase (empty for no passphrase): <br>\n",
    "\\# Enter same passphrase again:<br>\n",
    "\n",
    "接下来，显示如下代码提示，则说明，你的 SSH key 已经创建成功，只需要添加到github的SSH key上就可以了。如：<br>\n",
    ">Your identification has been saved in /c/Users/you/.ssh/id_rsa.<br>\n",
    "\\# Your public key has been saved in /c/Users/you/.ssh/id_rsa.pub.<br>\n",
    "\\# The key fingerprint is:<br>\n",
    "\\# 01:0f:f4:3b:ca:85:d6:17:a1:7d:f0:68:9d:f0:a2:db your_email@example.com<br>\n",
    "\n",
    "#### 　3、添加你的 SSH key 到 github上面去<br>\n",
    "a、首先你需要拷贝 id_rsa.pub 文件的内容，你可以用编辑器打开文件复制，也可以用git命令复制该文件的内容，如：<br>\n",
    ">clip < ~/.ssh/id_rsa.pub<br>\n",
    "\n",
    "b、登录你的github账号，从又上角的设置（ Account Settings ）进入，然后点击菜单栏的 SSH key 进入页面添加 SSH key。<br>\n",
    "c、点击 Add SSH key 按钮添加一个 SSH key 。把你复制的 SSH key 代码粘贴到 key 所对应的输入框中，记得 SSH key 代码的前后不要留有空格或者回车。当然，上面的 Title 所对应的输入框你也可以输入一个该 SSH key 显示在 github 上的一个别名。默认的会使用你的邮件名称。<br>\n",
    "\n",
    "#### 　4、测试一下该SSH key\n",
    "首先要给github bash输入一下代码:<br>\n",
    ">ssh -T git@github.com<br>\n",
    "\n",
    "当你输入以上代码时，会有一段警告代码，如：<br>\n",
    ">The authenticity of host 'github.com (207.97.227.239)' can't be established.<br>\n",
    "\\# RSA key fingerprint is 16:27:ac:a5:76:28:2d:36:63:1b:56:4d:eb:df:a6:48.<br>\n",
    "\\# Are you sure you want to continue connecting (yes/no)?<br>\n",
    "\n",
    "这是正常的，你输入 yes 回车既可。如果你创建 SSH key 的时候设置了密码，接下来就会提示你输入密码，如：<br>\n",
    ">Enter passphrase for key '/c/Users/Administrator/.ssh/id_rsa':<br>\n",
    "\n",
    "注意：输入密码时如果输错一个字就会不正确，使用删除键是无法更正的。密码正确后你会看到下面这段话，如：<br>\n",
    ">Hi username! You've successfully authenticated, but GitHub does not<br>\n",
    "\\# provide shell access.<br>\n",
    "\n",
    "如果用户名是正确的,你已经成功设置SSH密钥。如果你看到 “access denied” ，者表示拒绝访问，那么你就需要使用 https 去访问，而不是 SSH 。<br>\n",
    "其中还要对Github上的ssh key进行配置（添加一个新的key）：<br>\n",
    "在个人信息模块找到自己的setting值中心，然后在左边栏里找到SSH and GPG keys这一栏，点击出现创建的新的key（New SSH key按钮）开始创建新的key，如下图：<br>\n",
    "![设置GitHubKey](./images/github_sshKey.jpg)\n",
    "在未配置成功的时候，左边的钥匙为灰色，当完成（4、测试一下该SSH key）之后，出现成功提示后，刷新代码就会变成如上图所示的绿色图标。<br>\n",
    "#### 　5、生成多个SSH密钥\n",
    "在 SSH 用户配置文件 ~/.ssh/config 中指定对应服务所使用的公秘钥名称，如果没有 config 文件的话就新建一个，并输入以下内容：<br>\n",
    ">Host github.com www.github.com<br>\n",
    "IdentityFile ~/.ssh/aysee<br>\n",
    "\n",
    "步骤3、4，添加 aysee.pub 公钥到你的git服务器网站上，并测试链接。<br>\n",
    "如果出现如下提示，则说明有权限问题：<br>\n",
    ">Permission denied (publickey)<br>\n",
    "\n",
    "多用户时出现权限问题的原因：<br>\n",
    "　　github使用SSH与客户端连接。如果是单用户（first），生成密钥对后，将公钥保存至 GitHub ，每次连接时SSH客户端发送本地私钥（默认~/.ssh/id_rsa）到服务端验证。单用户情况下，连接的服务器上保存的公钥和发送的私钥自然是配对的。但是如果是多用户 （first，second），我们在连接到second的帐号时，second保存的是自己的公钥，但是SSH客户端依然发送默认私钥，即first的私钥，那么这个验证自然无法通过。<br>\n",
    "解决ssh权限问题:<br>\n",
    "通常一台电脑生成一个ssh不会有这个问题，当一台电脑生成多个ssh的时候，就可能遇到这个问题，解决步骤如下：<br>\n",
    "1、查看系统ssh-key代理,执行如下命令<br>\n",
    ">ssh-add -l<br>\n",
    "\n",
    "以上命令如果输出  The agent has no identities. 则表示没有代理。如果系统有代理，可以执行下面的命令清除代理:<br>\n",
    ">ssh-add -D<br>\n",
    "\n",
    "2、然后依次将不同的ssh添加代理，执行命令如下：<br>\n",
    ">ssh-add ~/.ssh/id_rsa<br>\n",
    "ssh-add ~/.ssh/aysee<br>\n",
    "\n",
    "你会分别得到如下提示：<br>\n",
    ">2048 8e:71:ad:88:78:80:b2:d9:e1:2d:1d:e4:be:6b:db:8e /Users/aysee/.ssh/id_rsa (RSA)<br>\n",
    "2048 a7:f4:0d:f1:b1:76:0b:bf:ed:9f:53:8c:3f:4c:f4:d6 /Users/aysee/.ssh/aysee (RSA)<br>\n",
    "\n",
    "如果使用 ssh-add ~/.ssh/id_rsa的时候报如下错误，则需要先运行一下 ssh-agent bash 命令后再执行 ssh-add ...等命令<br>\n",
    ">Could not open a connection to your authentication agent.<br>\n",
    "\n",
    "3、配置 ~/.ssh/config 文件<br>\n",
    "　　如果没有就在~/.ssh目录创建config文件，该文件用于配置私钥对应的服务器<br>\n",
    ">\\# Default github user(first@mail.com)<br>\n",
    "Host github.com<br>\n",
    "HostName github.com<br>\n",
    "User git<br>\n",
    "IdentityFile C:/Users/username/.ssh/id_rsa<br>\n",
    "\\# aysee (company_email@mail.com)<br>\n",
    "Host github-aysee<br>\n",
    "HostName github.com<br>\n",
    "User git<br>\n",
    "IdentityFile C:/Users/username/.ssh/aysee<br>\n",
    "\n",
    "　　Host随意即可，方便自己记忆，后续在添加remote是还需要用到。 配置完成后，在连接非默认帐号的github仓库时，远程库的地址要对应地做一些修改，比如现在添加second帐号下的一个仓库test，则需要这样添加：<br>\n",
    ">git remote add test git@github-aysee:ay-seeing/test.git<br>\n",
    "#并非原来的git@github.com:ay-seeing/test.git,ay-seeing 是github的用户名<br>\n",
    "\n",
    "4、测试链接 SSH<br>\n",
    "### 3、Git 某些编码显示问题\n",
    "#### 3.1 Windows系统中cmd和pycharm终端 git log 中文显示乱码的解决办法\n",
    "**方式1：**<br>\n",
    "临时解决，在cmd终端中输入 <br>\n",
    ">set LESSCHARSET=utf-8<br>\n",
    "\n",
    "然后再使用git log，可以发现乱码已经解除。 以上命令只能在当前窗口生效，重新打开，又复原了。<br>\n",
    "**方法2(推荐)：**<br>\n",
    "永久生效，在Windows环境变量中设置 LESSCHARSET=UTF-8<br>\n",
    "然后重新打开pycharm或者终端，再使用git log时，中文已正常显示<br>\n",
    "\n",
    "### 4、Git 忽略某些文件(夹)提交、更新\n",
    "　　在使用git开发时，我们往往不需要上传更新某些文件或文件夹，每次要手动取消上传或更新就显得比较麻烦，所以我们可以通过配置.gitignore文件的方法，忽略某些文件(夹)提交、更新。<br>\n",
    "　　在项目根目录内新建文本文件，并重命名为.gitignore，该文件语法如下：\n",
    ">\\# 以'#'开始的行，被视为注释.<br>                                                                      \\# 忽略掉所有文件名是 a.txt的文件.<br>\n",
    "a.txt<br>\n",
    "\\# 忽略所有生成的 java文件,<br>\n",
    "\\*.java<br>\n",
    "\\# a.java是手工维护的，所以例外.<br>\n",
    "!a.java<br>\n",
    "\\# 忽略所有.o和 .a文件.<br>\n",
    "\\*.\\[oa\\]<br>\n",
    "\n",
    "　　**配置语法：**<br>\n",
    "以斜杠“/”开头表示目录；<br>\n",
    "以星号“\\*”通配多个字符；<br>\n",
    "以问号“?”通配单个字符<br>\n",
    "以方括号“\\[\\]”包含单个字符的匹配列表；<br>\n",
    "以叹号“!”表示不忽略(跟踪)匹配到的文件或目录；<br>\n",
    "　　**常用的规则：** <br>\n",
    "1）/target/ 过滤整个target文件夹 <br>\n",
    "2）*.html 过滤所有.html文件 <br>\n",
    "3）/doc/doc.doc 过滤某个具体文件<br>\n",
    "\n",
    "　　**注意**<br>\n",
    "　　我们不能在windows中直接建立.gitnore文件，因为是点开头，没有文件名，没办法直接在windows目录下直接创建，必须通过右键Git Bash，按照linux的方式来新建.gitignore文件或者直接在IDE中创建\n",
    "　　有时即使创建了.gitignore文件，却依然不能忽略，请检查语法是否有误，若果确定无误，可以在项目根路径下使用Git Bash以下命令：\n",
    ">git rm -r --cached .<br>\n",
    "git add .<br>\n",
    "git commit -m 'update .gitignore'<br>\n",
    "\n",
    "　　注意命令中的 . 别忘了"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3 (ipykernel)",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.9.7"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 2
}