mirror of
https://github.com/aliasvault/aliasvault.git
synced 2026-05-24 08:17:57 -04:00
Add Safari extension docs (#680)
This commit is contained in:
committed by
Leendert de Borst
parent
d0140a8ddb
commit
499d2759ce
53
docs/browser-extensions/safari/build-from-source.md
Normal file
53
docs/browser-extensions/safari/build-from-source.md
Normal file
@@ -0,0 +1,53 @@
|
||||
---
|
||||
layout: default
|
||||
title: Build from Source
|
||||
parent: Safari
|
||||
grand_parent: Browser Extensions
|
||||
nav_order: 2
|
||||
---
|
||||
|
||||
# Building Safari Extension from Source
|
||||
|
||||
This guide explains how to build and install the AliasVault Safari extension from source code.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Node.js installed on your computer
|
||||
- Git to clone the repository (optional)
|
||||
- MacOS machine with Xcode installed
|
||||
|
||||
## Building the Safari Extension
|
||||
|
||||
1. Clone the repository:
|
||||
```bash
|
||||
git clone https://github.com/lanedirt/AliasVault.git
|
||||
```
|
||||
|
||||
2. Navigate to the Browser Extension directory:
|
||||
```bash
|
||||
cd AliasVault/browser-extension
|
||||
```
|
||||
|
||||
3. Install the required dependencies:
|
||||
```bash
|
||||
npm install
|
||||
```
|
||||
|
||||
4. Build the extension:
|
||||
```bash
|
||||
npm run build:safari
|
||||
```
|
||||
|
||||
5. Open Xcode and open the `browser-extension/safari-xcode/AliasVault/AliasVault.xcodeproj` file
|
||||
|
||||
6. Run the project. This will open up the AliasVault MacOS wrapper app and automatically install the extension to your Safari Extensions list.
|
||||
|
||||
## Installing and enabling the extension in Safari
|
||||
|
||||
1. Open Safari and go to menu > Safari > Settings
|
||||
2. Click on the "Extensions" tab
|
||||
3. Enable the AliasVault extension. If the extension is not visible, then you may need to enable developer mode in Safari settings first to allow unsigned extensions to run.
|
||||
|
||||
## Development Mode (Optional)
|
||||
|
||||
If you plan to modify the extension code, see the [browser-extensions](../../misc/dev/browser-extensions.md) developer documentation for more information.
|
||||
19
docs/browser-extensions/safari/index.md
Normal file
19
docs/browser-extensions/safari/index.md
Normal file
@@ -0,0 +1,19 @@
|
||||
---
|
||||
layout: default
|
||||
title: Safari
|
||||
parent: Browser Extensions
|
||||
nav_order: 1
|
||||
---
|
||||
|
||||
# Safari Extension
|
||||
In order to install the Safari Extension, see the options below.
|
||||
|
||||
## MacOS App Store
|
||||
Installing the extension from the MacOS App Store is the easiest way to get started. This ensures that you are always using the latest version of the extension.
|
||||
|
||||
1. Go to the [MacOS App Store](https://apps.apple.com/app/id6743163173) page
|
||||
2. Click on the "Get" button
|
||||
3. The extension will be installed and added to Safari. Follow the instructions in the AliasVault MacOS app that is shown on screen after installation.
|
||||
|
||||
## Build from Source
|
||||
If you wish to install the extension from source instead, see the [build-from-source](build-from-source.md) documentation. This will allow you to make changes to the extension and/or to use a specific version of the extension.
|
||||
Reference in New Issue
Block a user