Skip to content

Commit e2e06d3

Browse files
committed
Дописал еще несколько разделов
1 parent 09e7bb9 commit e2e06d3

File tree

7 files changed

+144
-1
lines changed

7 files changed

+144
-1
lines changed

.vitepress/config.mts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ export default defineConfig({
2323

2424
lang: 'ru-RU',
2525

26-
base: '/OneScript.WebSite',
26+
base: '/',
2727

2828
srcDir: 'docs',
2929

docs/images/vscode-launch.png

46 KB
Loading

docs/images/vscode-plugins.png

-9.2 KB
Loading

docs/learn/debug.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# Отладка
2+
3+
Для отладки применяется стандартный отладчик OneScript для Visual Studio Code.
4+
5+
## Подготовка
6+
7+
Если у вас уже установлены VS Code, плагин языка 1С и отладчик OneScript, пропустите раздел "Подготовка".
8+
9+
### Установка Visual Studio Code и плагинов
10+
11+
Скачайте среду разработки с [сайта производителя](https://code.visualstudio.com/download) и установите. Затем, запустите и нажмите в ней `Ctrl+Shift+X` чтобы перейти к окну установки расширений.
12+
13+
Вам потребуется установить 2 расширения: поддержку языка 1С и отладчик OneScript. В окне поиска наберите bsl и установите расширения, показанные на картинке.
14+
15+
![](/images/vscode-plugins.png)
16+
17+
### Создание папки с решением
18+
19+
Для начала нам понадобится место, где мы будем писать наш проект. Ознакомьтесь с разделом [Новый проект](/learn/new-project), чтобы его подготовить.
20+
21+
## Конфигурация запуска
22+
23+
Для отладки нам потребуется `конфигурация запуска`. Конфигураций запуска может быть несколько, вы сами создаете варианты запуска с разными параметрами командной строки, с разными переменными окружения и т.п.
24+
25+
Запустите отладку и выберите пункт `Отладка 1Script`. IDE создаст файл `.vscode/launch.json` и откроет его в редакторе. Если что-то не сработает (а такое бывает), создайте в корне вашего проекта каталог `.vscode` (обратите внимание на точку в имени) и в нем файл `launch.json`, откройте его.
26+
27+
![](/images/vscode-launch.png)
28+
29+
В файле launch.json можно задать несколько так называемых "профилей" отладки - наборов комбинаций параметров, под которым будет запускаться отлаживаемое приложение.
30+
31+
Каждый профиль отладки представляет собой настройку запуска отлаживаемого приложения, его аргументы командной строки и версию интерпретатора 1script, которая будет выполнять приложение.
32+
33+
Подробное описание каждого параметра выводится при наведении мышки на опцию в файле launch.json.
34+
35+
```json
36+
{
37+
"name": "Отладка 1Script",
38+
"type": "oscript",
39+
"request": "launch",
40+
"cwd": "${workspaceRoot}/src",
41+
"program": "my-program.os",
42+
"args": ["arg1", "arg2"],
43+
"env": {
44+
"OSCRIPT_CONFIG": "lib.system=D:/myOsLibraries",
45+
"JAVA_HOME": "D:/MyJava/JDK_29_Full"
46+
},
47+
"debugPort": 2801
48+
}
49+
```
50+
51+
::: warning ВНИМАНИЕ
52+
Если по какой-либо причине на вашей машине занят порт `2801` - укажите в свойстве `debugPort` любой другой свободный порт.
53+
:::
54+
55+
## Старт отладки
56+
57+
После того, как конфигурация запуска выбрана в окне VS Code можно нажать кнопку F5 и среда разработки запустит отладку, согласно настроенной конфигурации.
58+
59+
Если взять пример конфига, приведенный выше, то будет запущен для отладки файл `my-program-os`, рабочим каталогом запущенного процесса будет каталог `${workspaceRoot}/src`, где ${workspaceRoot} это корень папки с проектом.
60+
61+
Далее, в запущенный процесс будут переданы 2 аргумента командной строки: "arg1" и "arg2", при этом процесс получит две переменные окружения OSCRIPT_CONFIG и JAVA_HOME.
62+
63+
Создавая таким образом разные варианты запуска, вы можете отлаживать различные сценарии вашей программы.

docs/learn/enterprise.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Документы и полезная информация для организаций и учреждений
2+
3+
## Применимость в корпоративной среде
4+
5+
1Script популярный открытый движок, который используется в корпоративной среде, в т.ч. в крупных компаниях, корпорациях, банках. Авторам известно, что он используется как минимум:
6+
7+
* В операторе сотовой связи из "большой тройки"
8+
* федеральном банке из ТОП-5
9+
* федеральной компании со словом "Газ" в названии
10+
* судостроении
11+
* и много где еще
12+
13+
На данной странице публикуются материалы, которые вы можете найти материалы, помогающие в работе с корпоративными службами при внедрении 1Script
14+
15+
## Материалы по информационной безопасности
16+
17+
Типовые требования служб ИБ к информационным системам
18+
19+
|Требование|Реализация в 1Script|
20+
|-|-|
21+
|Методы оповещения пользователей об уязвимостях решения и рекомендациях по их устранению.|Пользователи уведомляются в канале https://t.me/oscript_library. Информация о критичных уязвимостях показывается на [главной странице сайта](https://oscript.io) |
22+
|Политика устранения уязвимостей|Обнаруживаемые уязвимости устраняются в приоритетном порядке, как только авторы уязвимых библиотек, фреймворков выпускают исправление. Как правило, это 2-3 дня после появления исправления. Уязвимости в самом движке так же исправляются в приоритетном порядке. Гарантии по срокам исправления доступны только на базе платной поддержки.|
23+
|Политика обновления используемых библиотек, платформ|Движок основан на последних актуальных релизах .NET Framework и .NET. При выходе LTS-релизов осуществляется переход на них в плановом порядке|
24+
|Отсутствие недокументированных возможностей (НДВ)|НДВ отсутствуют, исходный код открыт|
25+
|Отсутствие неотключаемых функций взаимодействия с Интернет|Неотключаемые функции отсутствуют, при блокировании доступа в Интернет работоспособность 1Script сохраняется. Перестанут работать только попытки пользователя явно выйти в интернет средствами программы.|
26+
|Параметры резервного копирования, перечень компонентов, подлежащих резервному копированию.|Неприменимо, т.к. отсутствует база данных и какое-либо хранимое состояние, требующее резервного копирования.|
27+
|Релизная политика, сроки выпуска релизов.|Стабильные номерные релизы выпускаются в среднем каждые 3-4 месяца. Версии с долгосрочной поддержкой (LTS) выпускаются каждые 6-8 месяцев, ошибки в них исправляются в течение года с момента выпуска. Релизы выпускаются по мере накопления полезной функциональности или исправления ошибок. Кроме того, на сайте публикуются ночные сборки. В них включены самые свежие изменения. Можно сказать, что публикация исправлений происходит немедленно после внесения исправления в код.|
28+
|Change Logs и описания изменений.|К каждому релизу прилагается Changelog, кроме того, за счет открытости кода, все изменения видны в логе коммитов git. Увидеть changelog каждой версии можно на странице версии (см. "Предыдущие версии" страницы скачивания релизов)|
29+
30+
## Информационная поддержка
31+
32+
Мы будем признательны, если Ваша компания разрешит нам опубликовать на сайте информацию о том, что Вы применяете 1Script. Нам доверяют многие крупные компании, но мы не вели с ними переговоров об использовании нами брендов на сайте, поэтому не называем имен. Если вы хотите дать нам такое разрешение или знаете, к кому в Вашей компании можно обратиться за таким разрешением, [напишите нам, пожалуйста](https://t.me/oscript_library).
33+
34+
## Платная поддержка
35+
36+
У команды разработчиков на данный момент отсутствует функция платной поддержки, т.к. за таковой никто не обращался, но мы открыты к предложениям. Напишите в Telegram-канал https://t.me/oscript_library или создайте [issue на github](https://github.com/EvilBeaver/OneScript/issues).

docs/learn/infra.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Устройство и инфраструктура
2+
3+
## Архитектура
4+
5+
1Script написан на языке C# и работает на платформе .NET Актуальная версия платформы - NET6. По мере необходимости, версия платформы поднимается до актуальных.
6+
7+
::: info
8+
Предыдущие версии 1Script за номером 1.x используют версию .NET Framework 4.8 на Windows и Mono 6.12 на Linux
9+
:::
10+
11+
1Script поставляется в двух вариантах дистрибутивов:
12+
13+
* SCD (self-contained-deployment) - самостоятельный дистрибутив для конкретной операционной системы
14+
* FDD (framework-dependent-deployment) - универсальный дистрибутив, не зависящий от ОС, но требующий установки .NET на целевой машине
15+
16+
Для каждого сценария использования могут подходить разные варианты поставки, решать вам.
17+
18+
Если вам нужно "просто 1Скрипт" ставьте SCD для вашей ОС. Если вы, например, собираете docker-образ, в котором уже есть .NET нужной версии, то полный дистрибутив SCD вам не нужен, и вам будет достаточно маленького легковесного FDD.
19+
20+
Также, вам будет достаточно FDD, если у вас на машине уже стоит .NET нужной версии.
21+
22+
### Принцип работы
23+
24+
1Script исполняется посредством стековой машины с собственным байт-кодом. Также существует специальный режим компиляции `native`, который компилирует код 1С в байткод непосредственно машины dotnet. Этот режим является экспериментальным и несовместим по поведению с языком 1С (код должен быть написан в строго-типизированном стиле). Документирование режима native пока в разработке.
25+
26+
Виртуальная машина способна подключать внутрь себя сторонние файлы скриптов, на этом основана модульность исполняющей среды и организованы библиотеки.
27+
28+
## Хаб пакетов
29+
30+
Сообщество поддерживает [облачное хранилище повторно используемых библиотек](https://hub.oscript.io), называемое "Хаб пакетов". В это хранилище разработчики публикуют свои решения, которые так или иначе могут использоваться повторно всеми желающими. Хаб пакетов имеет несколько зеркал в случае выхода из строя основного сайта.
31+
32+
Пакеты распространяются в виде файлов с расширением `.ospx`, которые технически представляют собой zip-архивы специального формата. Упаковка решения в архив `.ospx` выполняется утилитой opm (OneScript Package Manager). В дальнейшем, опубликованный пакет с помощью той же утилиты устанавливается на машины конечных пользователей. Подробнее об этом механизме можно почитать в разделе ["Библиотеки"](/learn/libraries)
33+
34+
## Основной сайт
35+
36+
Сайт, на котором вы сейчас находитесь имеет открытые исходные коды и может так же дорабатываться сообществом (например, Вами).
37+
Инфраструктура сайта построена вокруг docker-compose.
38+
39+
## Информационная безопасность
40+
41+
Проект имеет открытый исходный код и мы стремимся к тому, чтобы он мог беспрепятственно использоваться в различных организациях и государственных учреждениях. Мы стараемся идти на встречу запросам от корпоративного сектора, если они у вас есть, вы можете их задать [напрямую авторам](https://t.me/oscript_library).
42+
43+
Также мы подготовили [ответы на наиболее часто встречающиеся вопросы](/learn/enterprise) от отделов информ.безопасности, вы можете предоставить эту информацию вашей службе infosec.

docs/learn/libraries.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Библиотеки

0 commit comments

Comments
 (0)